From 81da37b66224e689bc38cdb17c1919235152f9fe Mon Sep 17 00:00:00 2001 From: Glenn Morris Date: Sun, 25 Jul 2021 09:44:37 -0700 Subject: Fix recent gdb-mi change * lisp/progmodes/gdb-mi.el (gdb-registers-filter-pattern-list): Fix type. --- lisp/progmodes/gdb-mi.el | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'lisp/progmodes/gdb-mi.el') diff --git a/lisp/progmodes/gdb-mi.el b/lisp/progmodes/gdb-mi.el index 38dd0a77026..57c99abec64 100644 --- a/lisp/progmodes/gdb-mi.el +++ b/lisp/progmodes/gdb-mi.el @@ -594,7 +594,7 @@ filter." Each pattern is a regular expression. GDB displays registers whose name matches any pattern in the list. Refresh the register buffer for the change to take effect." - :type 'list + :type '(repeat regexp) :group 'gdb-buffers :version "28.1") -- cgit v1.2.3 From 29d62099957b2269c2505be3a9059c88d2d71881 Mon Sep 17 00:00:00 2001 From: Brian Leung Date: Mon, 19 Jul 2021 23:41:01 -0700 Subject: Ensure that gud commands for M-x gdb are handled by repeat-mode * lisp/progmodes/gud.el (gud-gdb-repeat-map): Rename from gud-repeat-map, and populate at the top-level. (gud-set-repeat-map-property): Introduce this helper function for setting the repeat-map property. (gud-gdb): Use the gud-set-repeat-map-property function to assign the repeat-map property. * lisp/progmodes/gdb-mi.el (gdb): Use the gud-set-repeat-map-property function to assign the repeat-map property. Because different debugging tools may not support all of the gud-foo functions, we reassign the repeat-map property within the respective commands, as opposed to the top level of the files, to ensure that the repeat-map property is reassigned each time to a symbol corresponding to the active debugging tool. (Bug#49632) --- lisp/progmodes/gdb-mi.el | 2 ++ lisp/progmodes/gud.el | 37 +++++++++++++++++++++++++------------ 2 files changed, 27 insertions(+), 12 deletions(-) (limited to 'lisp/progmodes/gdb-mi.el') diff --git a/lisp/progmodes/gdb-mi.el b/lisp/progmodes/gdb-mi.el index 57c99abec64..b9c8305bed0 100644 --- a/lisp/progmodes/gdb-mi.el +++ b/lisp/progmodes/gdb-mi.el @@ -996,6 +996,8 @@ detailed description of this mode. (define-key gud-minor-mode-map [left-margin C-mouse-3] 'gdb-mouse-jump) + (gud-set-repeat-map-property 'gud-gdb-repeat-map) + (setq-local gud-gdb-completion-function 'gud-gdbmi-completions) (add-hook 'completion-at-point-functions #'gud-gdb-completion-at-point diff --git a/lisp/progmodes/gud.el b/lisp/progmodes/gud.el index 740a6e25812..c4413b104bb 100644 --- a/lisp/progmodes/gud.el +++ b/lisp/progmodes/gud.el @@ -320,10 +320,32 @@ Used to gray out relevant toolbar icons.") (tool-bar-local-item-from-menu (car x) (cdr x) map gud-minor-mode-map)))) -(defvar gud-repeat-map (make-sparse-keymap) - "Keymap to repeat gud stepping instructions `C-x C-a C-n n n'. +(defvar gud-gdb-repeat-map + (let ((map (make-sparse-keymap))) + (pcase-dolist (`(,key . ,cmd) '(("n" . gud-next) + ("s" . gud-step) + ("i" . gud-stepi) + ("c" . gud-cont) + ("l" . gud-refresh) + ("f" . gud-finish) + ("<" . gud-up) + (">" . gud-down))) + (define-key map key cmd)) + map) + "Keymap to repeat `gud-gdb' stepping instructions `C-x C-a C-n n n'. Used in `repeat-mode'.") +(defun gud-set-repeat-map-property (keymap-symbol) + "Set the `repeat-map' property of relevant gud commands to KEYMAP-SYMBOL. + +KEYMAP-SYMBOL is a symbol corresponding to some +`-repeat-map', a keymap containing gud commands that may be +repeated when `repeat-mode' is on." + (map-keymap-internal (lambda (_ cmd) + (put cmd 'repeat-map keymap-symbol)) + (symbol-value keymap-symbol))) + + (defun gud-file-name (f) "Transform a relative file name to an absolute file name. Uses `gud--directories' to find the source files." @@ -814,16 +836,7 @@ the buffer in which this command was invoked." (gud-def gud-until "until %l" "\C-u" "Continue to current line.") (gud-def gud-run "run" nil "Run the program.") - (dolist (cmd '(("n" . gud-next) - ("s" . gud-step) - ("i" . gud-stepi) - ("c" . gud-cont) - ("l" . gud-refresh) - ("f" . gud-finish) - ("<" . gud-up) - (">" . gud-down))) - (define-key gud-repeat-map (car cmd) (cdr cmd)) - (put (cdr cmd) 'repeat-map 'gud-repeat-map)) + (gud-set-repeat-map-property 'gud-gdb-repeat-map) (add-hook 'completion-at-point-functions #'gud-gdb-completion-at-point nil 'local) -- cgit v1.2.3 From 051434fdefd6418bf1f0cd28c087b31cb3921f48 Mon Sep 17 00:00:00 2001 From: Mattias Engdegård Date: Sun, 8 Aug 2021 18:58:46 +0200 Subject: Use string-replace instead of replace-regexp-in-string `string-replace` is easier to understand, less error-prone, much faster, and results in shorter Lisp and byte code. Use it where applicable and obviously safe (erring on the conservative side). * admin/authors.el (authors-scan-change-log): * lisp/autoinsert.el (auto-insert-alist): * lisp/calc/calc-prog.el (calc-edit-macro-combine-alg-ent) (calc-edit-macro-combine-ext-command) (calc-edit-macro-combine-var-name): * lisp/calc/calc-units.el (math-make-unit-string): * lisp/calendar/cal-html.el (cal-html-comment): * lisp/calendar/cal-tex.el (cal-tex-comment): * lisp/calendar/icalendar.el (icalendar--convert-string-for-export) (icalendar--convert-string-for-import): * lisp/calendar/iso8601.el (iso8601--concat-regexps) (iso8601--full-time-match, iso8601--combined-match): * lisp/calendar/time-date.el (format-seconds): * lisp/calendar/todo-mode.el (todo-filter-items-filename): * lisp/cedet/cedet-files.el (cedet-directory-name-to-file-name) (cedet-file-name-to-directory-name): * lisp/comint.el (comint-watch-for-password-prompt): * lisp/dired-aux.el (dired-do-chmod): * lisp/dired-x.el (dired-man): * lisp/dired.el (dired-insert-directory, dired-goto-file-1): * lisp/emacs-lisp/comp.el (comp-c-func-name): * lisp/emacs-lisp/re-builder.el (reb-copy): * lisp/erc/erc-dcc.el (erc-dcc-unquote-filename): * lisp/erc/erc.el (erc-quit-reason-zippy, erc-part-reason-zippy) (erc-update-mode-line-buffer, erc-message-english-PART): * lisp/files.el (make-backup-file-name-1, files--transform-file-name) (read-file-modes): * lisp/fringe.el (fringe-mode): * lisp/gnus/gnus-art.el (gnus-button-handle-info-url): * lisp/gnus/gnus-group.el (gnus-group-completing-read): * lisp/gnus/gnus-icalendar.el (gnus-icalendar-event-from-ical): * lisp/gnus/gnus-mlspl.el (gnus-group-split-fancy): * lisp/gnus/gnus-search.el (gnus-search-query-parse-date) (gnus-search-transform-expression, gnus-search-run-search): * lisp/gnus/gnus-start.el (gnus-dribble-enter): * lisp/gnus/gnus-sum.el (gnus-summary-refer-article): * lisp/gnus/gnus-util.el (gnus-mode-string-quote): * lisp/gnus/message.el (message-put-addresses-in-ecomplete) (message-parse-mailto-url, message-mailto-1): * lisp/gnus/mml-sec.el (mml-secure-epg-sign): * lisp/gnus/mml-smime.el (mml-smime-epg-verify): * lisp/gnus/mml2015.el (mml2015-epg-verify): * lisp/gnus/nnmaildir.el (nnmaildir--system-name) (nnmaildir-request-list, nnmaildir-retrieve-groups) (nnmaildir-request-group, nnmaildir-retrieve-headers): * lisp/gnus/nnrss.el (nnrss-node-text): * lisp/gnus/spam-report.el (spam-report-gmane-internal) (spam-report-user-mail-address): * lisp/ibuffer.el (name): * lisp/image-dired.el (image-dired-pngnq-thumb) (image-dired-pngcrush-thumb, image-dired-optipng-thumb) (image-dired-create-thumb-1): * lisp/info.el (Info-set-mode-line): * lisp/international/mule-cmds.el (describe-language-environment): * lisp/mail/rfc2231.el (rfc2231-parse-string): * lisp/mail/rfc2368.el (rfc2368-parse-mailto-url): * lisp/mail/rmail.el (rmail-insert-inbox-text) (rmail-simplified-subject-regexp): * lisp/mail/rmailout.el (rmail-output-body-to-file): * lisp/mail/undigest.el (rmail-digest-rfc1153): * lisp/man.el (Man-default-man-entry): * lisp/mouse.el (minor-mode-menu-from-indicator): * lisp/mpc.el (mpc--debug): * lisp/net/browse-url.el (browse-url-mail): * lisp/net/eww.el (eww-update-header-line-format): * lisp/net/newst-backend.el (newsticker-save-item): * lisp/net/rcirc.el (rcirc-sentinel): * lisp/net/soap-client.el (soap-decode-date-time): * lisp/nxml/rng-cmpct.el (rng-c-literal-2-re): * lisp/nxml/xmltok.el (let*): * lisp/obsolete/nnir.el (nnir-run-swish-e, nnir-run-hyrex) (nnir-run-find-grep): * lisp/play/dunnet.el (dun-doassign): * lisp/play/handwrite.el (handwrite): * lisp/proced.el (proced-format-args): * lisp/profiler.el (profiler-report-header-line-format): * lisp/progmodes/gdb-mi.el (gdb-mi-quote): * lisp/progmodes/make-mode.el (makefile-bsdmake-rule-action-regex) (makefile-make-font-lock-keywords): * lisp/progmodes/prolog.el (prolog-guess-fill-prefix): * lisp/progmodes/ruby-mode.el (ruby-toggle-string-quotes): * lisp/progmodes/sql.el (sql-remove-tabs-filter, sql-str-literal): * lisp/progmodes/which-func.el (which-func-current): * lisp/replace.el (query-replace-read-from) (occur-engine, replace-quote): * lisp/select.el (xselect--encode-string): * lisp/ses.el (ses-export-tab): * lisp/subr.el (shell-quote-argument): * lisp/term/pc-win.el (msdos-show-help): * lisp/term/w32-win.el (w32--set-selection): * lisp/term/xterm.el (gui-backend-set-selection): * lisp/textmodes/picture.el (picture-tab-search): * lisp/thumbs.el (thumbs-call-setroot-command): * lisp/tooltip.el (tooltip-show-help-non-mode): * lisp/transient.el (transient-format-key): * lisp/url/url-mailto.el (url-mailto): * lisp/vc/log-edit.el (log-edit-changelog-ours-p): * lisp/vc/vc-bzr.el (vc-bzr-status): * lisp/vc/vc-hg.el (vc-hg--glob-to-pcre): * lisp/vc/vc-svn.el (vc-svn-after-dir-status): * lisp/xdg.el (xdg-desktop-strings): * test/lisp/electric-tests.el (defun): * test/lisp/term-tests.el (term-simple-lines): * test/lisp/time-stamp-tests.el (formatz-mod-del-colons): * test/lisp/wdired-tests.el (wdired-test-bug32173-01) (wdired-test-unfinished-edit-01): * test/src/json-tests.el (json-parse-with-custom-null-and-false-objects): Use `string-replace` instead of `replace-regexp-in-string`. --- admin/authors.el | 2 +- lisp/autoinsert.el | 4 ++-- lisp/calc/calc-prog.el | 8 ++++---- lisp/calc/calc-units.el | 2 +- lisp/calendar/cal-html.el | 2 +- lisp/calendar/cal-tex.el | 2 +- lisp/calendar/icalendar.el | 12 ++++++------ lisp/calendar/iso8601.el | 6 +++--- lisp/calendar/time-date.el | 2 +- lisp/calendar/todo-mode.el | 2 +- lisp/cedet/cedet-files.el | 4 ++-- lisp/comint.el | 2 +- lisp/dired-aux.el | 2 +- lisp/dired-x.el | 2 +- lisp/dired.el | 14 +++++++------- lisp/emacs-lisp/comp.el | 2 +- lisp/emacs-lisp/re-builder.el | 2 +- lisp/erc/erc-dcc.el | 4 ++-- lisp/erc/erc.el | 8 ++++---- lisp/files.el | 6 +++--- lisp/fringe.el | 2 +- lisp/gnus/gnus-art.el | 2 +- lisp/gnus/gnus-group.el | 2 +- lisp/gnus/gnus-icalendar.el | 8 ++++---- lisp/gnus/gnus-mlspl.el | 2 +- lisp/gnus/gnus-search.el | 10 +++++----- lisp/gnus/gnus-start.el | 2 +- lisp/gnus/gnus-sum.el | 2 +- lisp/gnus/gnus-util.el | 2 +- lisp/gnus/message.el | 8 ++++---- lisp/gnus/mml-sec.el | 2 +- lisp/gnus/mml-smime.el | 2 +- lisp/gnus/mml2015.el | 2 +- lisp/gnus/nnmaildir.el | 18 ++++++++---------- lisp/gnus/nnrss.el | 2 +- lisp/gnus/spam-report.el | 4 ++-- lisp/ibuffer.el | 2 +- lisp/image-dired.el | 8 ++++---- lisp/info.el | 4 ++-- lisp/international/mule-cmds.el | 2 +- lisp/mail/rfc2231.el | 2 +- lisp/mail/rfc2368.el | 2 +- lisp/mail/rmail.el | 4 ++-- lisp/mail/rmailout.el | 4 ++-- lisp/mail/undigest.el | 2 +- lisp/man.el | 2 +- lisp/mouse.el | 2 +- lisp/mpc.el | 4 ++-- lisp/net/browse-url.el | 2 +- lisp/net/eww.el | 2 +- lisp/net/newst-backend.el | 2 +- lisp/net/rcirc.el | 2 +- lisp/net/soap-client.el | 2 +- lisp/nxml/rng-cmpct.el | 2 +- lisp/nxml/xmltok.el | 2 +- lisp/obsolete/nnir.el | 12 ++++++------ lisp/play/dunnet.el | 2 +- lisp/play/handwrite.el | 2 +- lisp/proced.el | 2 +- lisp/profiler.el | 2 +- lisp/progmodes/gdb-mi.el | 2 +- lisp/progmodes/make-mode.el | 7 +++---- lisp/progmodes/prolog.el | 2 +- lisp/progmodes/ruby-mode.el | 4 ++-- lisp/progmodes/sql.el | 4 ++-- lisp/progmodes/which-func.el | 2 +- lisp/replace.el | 14 ++++++-------- lisp/select.el | 2 +- lisp/ses.el | 2 +- lisp/subr.el | 2 +- lisp/term/pc-win.el | 2 +- lisp/term/w32-win.el | 2 +- lisp/term/xterm.el | 5 ++--- lisp/textmodes/picture.el | 4 ++-- lisp/thumbs.el | 6 +++--- lisp/tooltip.el | 2 +- lisp/transient.el | 12 ++++++------ lisp/url/url-mailto.el | 2 +- lisp/vc/log-edit.el | 4 ++-- lisp/vc/vc-bzr.el | 2 +- lisp/vc/vc-hg.el | 4 ++-- lisp/vc/vc-svn.el | 2 +- lisp/xdg.el | 4 ++-- test/lisp/electric-tests.el | 2 +- test/lisp/term-tests.el | 2 +- test/lisp/time-stamp-tests.el | 2 +- test/lisp/wdired-tests.el | 4 ++-- test/src/json-tests.el | 2 +- 88 files changed, 164 insertions(+), 170 deletions(-) (limited to 'lisp/progmodes/gdb-mi.el') diff --git a/admin/authors.el b/admin/authors.el index 6c81c7872fc..a400b1327af 100644 --- a/admin/authors.el +++ b/admin/authors.el @@ -1475,7 +1475,7 @@ Suggested\\|Trivial\\|Version\\|Originally\\|From:\\|Patch[ \t]+[Bb]y\\)"))) (when (string-match ":" line) (setq line (substring line 0 (match-beginning 0))) (setq line (replace-regexp-in-string "[[(<{].*$" "" line)) - (setq line (replace-regexp-in-string "," "" line)) + (setq line (string-replace "," "" line)) (dolist (file (split-string line)) (when (setq file (authors-canonical-file-name file log-file pos (car authors))) (dolist (author authors) diff --git a/lisp/autoinsert.el b/lisp/autoinsert.el index 0392903c332..995d9e2e0fe 100644 --- a/lisp/autoinsert.el +++ b/lisp/autoinsert.el @@ -93,8 +93,8 @@ If this contains a %s, that will be replaced by the matching rule." '((("\\.\\([Hh]\\|hh\\|hpp\\|hxx\\|h\\+\\+\\)\\'" . "C / C++ header") (replace-regexp-in-string "[^A-Z0-9]" "_" - (replace-regexp-in-string - "\\+" "P" + (string-replace + "+" "P" (upcase (file-name-nondirectory buffer-file-name)))) "#ifndef " str \n "#define " str "\n\n" diff --git a/lisp/calc/calc-prog.el b/lisp/calc/calc-prog.el index 4e27d7671e2..6f1e5c782df 100644 --- a/lisp/calc/calc-prog.el +++ b/lisp/calc/calc-prog.el @@ -802,8 +802,8 @@ (when match (kill-line 1) (setq line (concat line (substring curline 0 match)))) - (setq line (replace-regexp-in-string "SPC" " SPC " - (replace-regexp-in-string " " "" line))) + (setq line (string-replace "SPC" " SPC " + (string-replace " " "" line))) (insert line "\t\t\t") (if (> (current-column) 24) (delete-char -1)) @@ -830,7 +830,7 @@ (when match (kill-line 1) (setq line (concat line (substring curline 0 match)))) - (setq line (replace-regexp-in-string " " "" line)) + (setq line (string-replace " " "" line)) (insert cmdbeg " " line "\t\t\t") (if (> (current-column) 24) (delete-char -1)) @@ -857,7 +857,7 @@ (when match (kill-line 1) (setq line (concat line (substring curline 0 match)))) - (setq line (replace-regexp-in-string " " "" line)) + (setq line (string-replace " " "" line)) (insert line "\t\t\t") (if (> (current-column) 24) (delete-char -1)) diff --git a/lisp/calc/calc-units.el b/lisp/calc/calc-units.el index c3adc3db02a..8b6f0637035 100644 --- a/lisp/calc/calc-units.el +++ b/lisp/calc/calc-units.el @@ -406,7 +406,7 @@ Entries are (SYMBOL EXPR DOC-STRING TEMP-TYPE BASE-UNITS).") If EXPR is nil, return nil." (if expr (let ((cexpr (math-compose-expr expr 0))) - (replace-regexp-in-string + (string-replace " / " "/" (if (stringp cexpr) cexpr diff --git a/lisp/calendar/cal-html.el b/lisp/calendar/cal-html.el index e5810c3f027..58a5a0f83a5 100644 --- a/lisp/calendar/cal-html.el +++ b/lisp/calendar/cal-html.el @@ -151,7 +151,7 @@ (defun cal-html-comment (string) "Return STRING as html comment." (format "\n" - (replace-regexp-in-string "--" "++" string))) + (string-replace "--" "++" string))) (defun cal-html-href (link string) "Return a hyperlink to url LINK with text STRING." diff --git a/lisp/calendar/cal-tex.el b/lisp/calendar/cal-tex.el index f5932014dd9..3830024ef3d 100644 --- a/lisp/calendar/cal-tex.el +++ b/lisp/calendar/cal-tex.el @@ -1755,7 +1755,7 @@ current contents." COMMENT may contain newlines, which are prefixed by \"% \" in the output." (insert (format "%% %s\n" (if comment - (replace-regexp-in-string "\n" "\n% " comment) + (string-replace "\n" "\n% " comment) "")))) (defun cal-tex-banner (comment) diff --git a/lisp/calendar/icalendar.el b/lisp/calendar/icalendar.el index d18ec5e798f..cf37331394c 100644 --- a/lisp/calendar/icalendar.el +++ b/lisp/calendar/icalendar.el @@ -998,15 +998,15 @@ TIMESTRING and has the same result as \"9:00\"." (defun icalendar--convert-string-for-export (string) "Escape comma and other critical characters in STRING." - (replace-regexp-in-string "," "\\\\," string)) + (string-replace "," "\\," string)) (defun icalendar--convert-string-for-import (string) "Remove escape chars for comma, semicolon etc. from STRING." - (replace-regexp-in-string - "\\\\n" "\n " (replace-regexp-in-string - "\\\\\"" "\"" (replace-regexp-in-string - "\\\\;" ";" (replace-regexp-in-string - "\\\\," "," string))))) + (string-replace + "\\n" "\n " (string-replace + "\\\"" "\"" (string-replace + "\\;" ";" (string-replace + "\\," "," string))))) ;; ====================================================================== ;; Export -- convert emacs-diary to iCalendar diff --git a/lisp/calendar/iso8601.el b/lisp/calendar/iso8601.el index f22f060e205..1de1796a054 100644 --- a/lisp/calendar/iso8601.el +++ b/lisp/calendar/iso8601.el @@ -57,7 +57,7 @@ (defun iso8601--concat-regexps (regexps) (mapconcat (lambda (regexp) (concat "\\(?:" - (replace-regexp-in-string "(" "(?:" regexp) + (string-replace "(" "(?:" regexp) "\\)")) regexps "\\|")) @@ -92,13 +92,13 @@ "\\(Z\\|\\([+-]\\)\\([0-9][0-9]\\):?\\([0-9][0-9]\\)?\\)") (defconst iso8601--full-time-match - (concat "\\(" (replace-regexp-in-string "(" "(?:" iso8601--time-match) "\\)" + (concat "\\(" (string-replace "(" "(?:" iso8601--time-match) "\\)" "\\(" iso8601--zone-match "\\)?")) (defconst iso8601--combined-match (concat "\\(" iso8601--date-match "\\)" "\\(?:T\\(" - (replace-regexp-in-string "(" "(?:" iso8601--time-match) + (string-replace "(" "(?:" iso8601--time-match) "\\)" "\\(" iso8601--zone-match "\\)?\\)?")) diff --git a/lisp/calendar/time-date.el b/lisp/calendar/time-date.el index 1c169b78fd6..0aa38166bc1 100644 --- a/lisp/calendar/time-date.el +++ b/lisp/calendar/time-date.el @@ -357,7 +357,7 @@ is output until the first non-zero unit is encountered." (format " %s%s" name (if (= num 1) "" "s")))) t t string)))))) - (replace-regexp-in-string "%%" "%" string)) + (string-replace "%%" "%" string)) (defvar seconds-to-string (list (list 1 "ms" 0.001) diff --git a/lisp/calendar/todo-mode.el b/lisp/calendar/todo-mode.el index 680beb85aff..371d10631c5 100644 --- a/lisp/calendar/todo-mode.el +++ b/lisp/calendar/todo-mode.el @@ -4546,7 +4546,7 @@ its priority has changed, and `same' otherwise." (let ((bufname (buffer-name))) (string-match "\"\\([^\"]+\\)\"" bufname) (let* ((filename-str (substring bufname (match-beginning 1) (match-end 1))) - (filename-base (replace-regexp-in-string ", " "-" filename-str)) + (filename-base (string-replace ", " "-" filename-str)) (top-priorities (string-match "top priorities" bufname)) (diary-items (string-match "diary items" bufname)) (regexp-items (string-match "regexp items" bufname))) diff --git a/lisp/cedet/cedet-files.el b/lisp/cedet/cedet-files.el index c9d557f5974..f540fb5540f 100644 --- a/lisp/cedet/cedet-files.el +++ b/lisp/cedet/cedet-files.el @@ -59,7 +59,7 @@ to the file's truename, and dodging platform tricks." ;; doubling `!'s in the original name... (setq file (subst-char-in-string ?/ ?! - (replace-regexp-in-string "!" "!!" file))) + (string-replace "!" "!!" file))) file)) (defun cedet-file-name-to-directory-name (referencefile &optional testmode) @@ -71,7 +71,7 @@ specific conversions during tests." ;; Replace the ! with / (setq file (subst-char-in-string ?! ?/ file)) ;; Occurrences of // meant there was once a single !. - (setq file (replace-regexp-in-string "//" "!" file)) + (setq file (string-replace "//" "!" file)) ;; Handle Windows special cases (when (or (memq system-type '(windows-nt ms-dos)) testmode) diff --git a/lisp/comint.el b/lisp/comint.el index 40f58f2da7b..7af8e8fd2a5 100644 --- a/lisp/comint.el +++ b/lisp/comint.el @@ -2439,7 +2439,7 @@ carriage returns (\\r) in STRING. This function could be in the list `comint-output-filter-functions'." (when (let ((case-fold-search t)) (string-match comint-password-prompt-regexp - (replace-regexp-in-string "\r" "" string))) + (string-replace "\r" "" string))) (let ((comint--prompt-recursion-depth (1+ comint--prompt-recursion-depth))) (if (> comint--prompt-recursion-depth 10) (message "Password prompt recursion too deep") diff --git a/lisp/dired-aux.el b/lisp/dired-aux.el index 060f3a84111..72969dd96e2 100644 --- a/lisp/dired-aux.el +++ b/lisp/dired-aux.el @@ -508,7 +508,7 @@ has no effect on MS-Windows." (default (and (stringp modestr) (string-match "^.\\(...\\)\\(...\\)\\(...\\)$" modestr) - (replace-regexp-in-string + (string-replace "-" "" (format "u=%s,g=%s,o=%s" (match-string 1 modestr) diff --git a/lisp/dired-x.el b/lisp/dired-x.el index a7bfae759ed..a990bd3fec3 100644 --- a/lisp/dired-x.el +++ b/lisp/dired-x.el @@ -1193,7 +1193,7 @@ NOSELECT the files are merely found but not selected." (interactive) (require 'man) (let* ((file (dired-get-filename)) - (manual-program (replace-regexp-in-string "\\*" "%s" + (manual-program (string-replace "*" "%s" (dired-guess-shell-command "Man command: " (list file))))) (Man-getpage-in-background file))) diff --git a/lisp/dired.el b/lisp/dired.el index 28448be06ce..e577df510ad 100644 --- a/lisp/dired.el +++ b/lisp/dired.el @@ -1587,8 +1587,8 @@ see `dired-use-ls-dired' for more details.") ;; because newlines in dirnames are uncommon, and people may ;; have gotten used to seeing unescaped "\" in the headers. ;; Note: adjust dired-build-subdir-alist if you change this. - (setq dir (replace-regexp-in-string "\\\\" "\\\\" dir nil t) - dir (replace-regexp-in-string "\n" "\\n" dir nil t))) + (setq dir (string-replace "\\" "\\\\" dir) + dir (string-replace "\n" "\\n" dir))) ;; If we used --dired and it worked, the lines are already indented. ;; Otherwise, indent them. (unless (save-excursion @@ -3167,15 +3167,15 @@ the quoted forms of those characters. FULL-NAME specifies the actual file name the listing must have, as returned by `dired-get-filename'. LIMIT is the search limit." (let (str) - (setq str (replace-regexp-in-string "\^m" "\\^m" file nil t)) - (setq str (replace-regexp-in-string "\\\\" "\\\\" str nil t)) + (setq str (string-replace "\^m" "\\^m" file)) + (setq str (string-replace "\\" "\\\\" str)) (and (dired-switches-escape-p dired-actual-switches) (string-match-p "[ \t\n]" str) ;; FIXME: to fix this for embedded control characters etc, we ;; should escape everything that `ls -b' does. - (setq str (replace-regexp-in-string " " "\\ " str nil t) - str (replace-regexp-in-string "\t" "\\t" str nil t) - str (replace-regexp-in-string "\n" "\\n" str nil t))) + (setq str (string-replace " " "\\ " str) + str (string-replace "\t" "\\t" str) + str (string-replace "\n" "\\n" str))) (let ((found nil) ;; filenames are preceded by SPC, this makes the search faster ;; (e.g. for the filename "-"). diff --git a/lisp/emacs-lisp/comp.el b/lisp/emacs-lisp/comp.el index a04413b6f00..ed75bf2bfa9 100644 --- a/lisp/emacs-lisp/comp.el +++ b/lisp/emacs-lisp/comp.el @@ -1171,7 +1171,7 @@ clashes." do (aset str j (aref byte 0)) (aset str (1+ j) (aref byte 1)) finally return str)) - (human-readable (replace-regexp-in-string + (human-readable (string-replace "-" "_" orig-name)) (human-readable (replace-regexp-in-string (rx (not (any "0-9a-z_"))) "" human-readable))) diff --git a/lisp/emacs-lisp/re-builder.el b/lisp/emacs-lisp/re-builder.el index 396949d59a2..aec438ed994 100644 --- a/lisp/emacs-lisp/re-builder.el +++ b/lisp/emacs-lisp/re-builder.el @@ -436,7 +436,7 @@ provided in the Commentary section of this library." (let ((re (with-output-to-string (print (reb-target-binding reb-regexp))))) (setq re (substring re 1 (1- (length re)))) - (setq re (replace-regexp-in-string "\n" "\\n" re nil t)) + (setq re (string-replace "\n" "\\n" re)) (kill-new re) (message "Copied regexp `%s' to kill-ring" re))) diff --git a/lisp/erc/erc-dcc.el b/lisp/erc/erc-dcc.el index 219af3741fa..fcdb8df2032 100644 --- a/lisp/erc/erc-dcc.el +++ b/lisp/erc/erc-dcc.el @@ -630,8 +630,8 @@ that subcommand." (define-inline erc-dcc-unquote-filename (filename) (inline-quote - (replace-regexp-in-string "\\\\\\\\" "\\" - (replace-regexp-in-string "\\\\\"" "\"" ,filename t t) t t))) + (string-replace "\\\\" "\\" + (string-replace "\\\"" "\"" ,filename)))) (defun erc-dcc-handle-ctcp-send (proc query nick login host to) "This is called if a CTCP DCC SEND subcommand is sent to the client. diff --git a/lisp/erc/erc.el b/lisp/erc/erc.el index 026c6f84164..c66b03d2e4e 100644 --- a/lisp/erc/erc.el +++ b/lisp/erc/erc.el @@ -3597,7 +3597,7 @@ If S is non-nil, it will be used as the quit reason." If S is non-nil, it will be used as the quit reason." (or s (if (fboundp 'yow) - (replace-regexp-in-string "\n" "" (yow)) + (string-replace "\n" "" (yow)) (erc-quit/part-reason-default)))) (make-obsolete 'erc-quit-reason-zippy "it will be removed." "24.4") @@ -3624,7 +3624,7 @@ If S is non-nil, it will be used as the part reason." If S is non-nil, it will be used as the quit reason." (or s (if (fboundp 'yow) - (replace-regexp-in-string "\n" "" (yow)) + (string-replace "\n" "" (yow)) (erc-quit/part-reason-default)))) (make-obsolete 'erc-part-reason-zippy "it will be removed." "24.4") @@ -6528,7 +6528,7 @@ if `erc-away' is non-nil." (fill-region (point-min) (point-max)) (buffer-string)))) (setq header-line-format - (replace-regexp-in-string + (string-replace "%" "%%" (if face @@ -6804,7 +6804,7 @@ functions." nick user host channel (if (not (string= reason "")) (format ": %s" - (replace-regexp-in-string "%" "%%" reason)) + (string-replace "%" "%%" reason)) ""))))) diff --git a/lisp/files.el b/lisp/files.el index 89ee13eb686..54d0b919e1d 100644 --- a/lisp/files.el +++ b/lisp/files.el @@ -5201,7 +5201,7 @@ The function `find-backup-file-name' also uses this." (expand-file-name (subst-char-in-string ?/ ?! - (replace-regexp-in-string "!" "!!" file)) + (string-replace "!" "!!" file)) backup-directory)) (expand-file-name (file-name-nondirectory file) (file-name-as-directory abs-backup-directory)))))) @@ -6876,7 +6876,7 @@ the resulting file name, and SUFFIX is appended." (file-name-directory result) (subst-char-in-string ?/ ?! - (replace-regexp-in-string + (string-replace "!" "!!" filename)))) (t result)))) (setq result @@ -7989,7 +7989,7 @@ based on existing mode bits, as in \"og+rX-w\"." (default (and (stringp modestr) (string-match "^.\\(...\\)\\(...\\)\\(...\\)$" modestr) - (replace-regexp-in-string + (string-replace "-" "" (format "u=%s,g=%s,o=%s" (match-string 1 modestr) diff --git a/lisp/fringe.el b/lisp/fringe.el index d73aae0459e..82cfacc6b6f 100644 --- a/lisp/fringe.el +++ b/lisp/fringe.el @@ -189,7 +189,7 @@ fringes." :type `(choice ,@ (mapcar (lambda (style) (let ((name - (replace-regexp-in-string "-" " " (car style)))) + (string-replace "-" " " (car style)))) `(const :tag ,(concat (capitalize (substring name 0 1)) (substring name 1)) diff --git a/lisp/gnus/gnus-art.el b/lisp/gnus/gnus-art.el index fb0295d0703..d65e75e44c2 100644 --- a/lisp/gnus/gnus-art.el +++ b/lisp/gnus/gnus-art.el @@ -8288,7 +8288,7 @@ url is put as the `gnus-button-url' overlay property on the button." ")" (gnus-url-unhex-string (match-string 2 url))))) ((string-match "([^)\"]+)[^\"]+" url) (setq url - (replace-regexp-in-string + (string-replace "\"" "" (replace-regexp-in-string "[\n\t ]+" " " url))) (gnus-info-find-node url)) (t (error "Can't parse %s" url)))) diff --git a/lisp/gnus/gnus-group.el b/lisp/gnus/gnus-group.el index 6202567344f..b1134397e55 100644 --- a/lisp/gnus/gnus-group.el +++ b/lisp/gnus/gnus-group.el @@ -2186,7 +2186,7 @@ handle COLLECTION as a list, hash table, or vector." require-match initial-input (or hist 'gnus-group-history) def))) - (replace-regexp-in-string "\n" "" group))) + (string-replace "\n" "" group))) ;;;###autoload (defun gnus-fetch-group (group &optional articles) diff --git a/lisp/gnus/gnus-icalendar.el b/lisp/gnus/gnus-icalendar.el index 1b2743c1484..56f4fdf6d33 100644 --- a/lisp/gnus/gnus-icalendar.el +++ b/lisp/gnus/gnus-icalendar.el @@ -252,10 +252,10 @@ ;; ugly, but cannot get ;;replace-regexp-in-string work with "\\" as ;;REP, plus we should also handle "\\;" - (replace-regexp-in-string - "\\\\," "," - (replace-regexp-in-string - "\\\\n" "\n" (substring-no-properties value)))))) + (string-replace + "\\," "," + (string-replace + "\\n" "\n" (substring-no-properties value)))))) (accumulate-args (mapping) (cl-destructuring-bind (slot . ical-property) mapping diff --git a/lisp/gnus/gnus-mlspl.el b/lisp/gnus/gnus-mlspl.el index d42f0971259..664027f0164 100644 --- a/lisp/gnus/gnus-mlspl.el +++ b/lisp/gnus/gnus-mlspl.el @@ -209,7 +209,7 @@ Calling (gnus-group-split-fancy nil nil \"mail.others\") returns: "\\)")) ;; Now create the new SPLIT (let ((split-regexp-with-list-ids - (replace-regexp-in-string "@" "[@.]" split-regexp t t)) + (string-replace "@" "[@.]" split-regexp)) (exclude ;; Generate RESTRICTs for SPLIT-EXCLUDEs. (if (listp split-exclude) diff --git a/lisp/gnus/gnus-search.el b/lisp/gnus/gnus-search.el index 8182630dfed..59b8efaa3ac 100644 --- a/lisp/gnus/gnus-search.el +++ b/lisp/gnus/gnus-search.el @@ -572,7 +572,7 @@ nil. If VALUE is a relative time, interpret it as relative to REL-DATE, or (current-time) if REL-DATE is nil." ;; Time parsing doesn't seem to work with slashes. - (let ((value (replace-regexp-in-string "/" "-" value)) + (let ((value (string-replace "/" "-" value)) (now (append '(0 0 0) (seq-subseq (decode-time (or rel-date (current-time))) @@ -1669,7 +1669,7 @@ cross our fingers for the rest of it." Mairix negation requires a \"~\" preceding string search terms, and \"-\" before marks." (let ((next (gnus-search-transform-expression engine (cadr expr)))) - (replace-regexp-in-string + (string-replace ":" (if (eql (caadr expr) 'mark) ":-" @@ -1863,9 +1863,9 @@ Assume \"size\" key is equal to \"larger\"." group (if (file-directory-p (setq group - (replace-regexp-in-string - "\\." "/" - group nil t))) + (string-replace + "." "/" + group))) group)))))) (unless group (signal 'gnus-search-config-error diff --git a/lisp/gnus/gnus-start.el b/lisp/gnus/gnus-start.el index 44e97d54846..02bbe19e7fe 100644 --- a/lisp/gnus/gnus-start.el +++ b/lisp/gnus/gnus-start.el @@ -854,7 +854,7 @@ If REGEXP is given, lines that match it will be deleted." (goto-char (point-max)) ;; Make sure that each dribble entry is a single line, so that ;; the "remove" code above works. - (insert (replace-regexp-in-string "\n" "\\\\n" string) "\n") + (insert (string-replace "\n" "\\n" string) "\n") (bury-buffer gnus-dribble-buffer) (with-current-buffer gnus-group-buffer (gnus-group-set-mode-line))))) diff --git a/lisp/gnus/gnus-sum.el b/lisp/gnus/gnus-sum.el index 4bdc2023eb4..dc004927b67 100644 --- a/lisp/gnus/gnus-sum.el +++ b/lisp/gnus/gnus-sum.el @@ -9191,7 +9191,7 @@ specified by the `gnus-refer-thread-limit' variable." (interactive "sMessage-ID: " gnus-summary-mode) (when (and (stringp message-id) (not (zerop (length message-id)))) - (setq message-id (replace-regexp-in-string " " "" message-id)) + (setq message-id (string-replace " " "" message-id)) ;; Construct the correct Message-ID if necessary. ;; Suggested by tale@pawl.rpi.edu. (unless (string-match "^<" message-id) diff --git a/lisp/gnus/gnus-util.el b/lisp/gnus/gnus-util.el index be0284515dc..7a5e00c5ec9 100644 --- a/lisp/gnus/gnus-util.el +++ b/lisp/gnus/gnus-util.el @@ -408,7 +408,7 @@ Cache the result as a text property stored in DATE." (defun gnus-mode-string-quote (string) "Quote all \"%\"'s in STRING." - (replace-regexp-in-string "%" "%%" string)) + (string-replace "%" "%%" string)) (defsubst gnus-make-hashtable (&optional size) "Make a hash table of SIZE, testing on `equal'." diff --git a/lisp/gnus/message.el b/lisp/gnus/message.el index bcbf7476715..a3ffaec3ff3 100644 --- a/lisp/gnus/message.el +++ b/lisp/gnus/message.el @@ -8599,7 +8599,7 @@ From headers in the original article." (let ((value (message-field-value header))) (dolist (string (mail-header-parse-addresses value 'raw)) (setq string - (replace-regexp-in-string + (string-replace "\n" "" (replace-regexp-in-string "^ +\\| +$" "" string))) (ecomplete-add-item 'mail (car (mail-header-parse-address string)) @@ -8889,7 +8889,7 @@ used to take the screenshot." (defun message-parse-mailto-url (url) "Parse a mailto: url." - (setq url (replace-regexp-in-string "\n" " " url)) + (setq url (string-replace "\n" " " url)) (when (string-match "mailto:/*\\(.*\\)" url) (setq url (substring url (match-beginning 1) nil))) (setq url (if (string-match "^\\?" url) @@ -8931,9 +8931,9 @@ will then start up Emacs ready to compose mail. For emacsclient use (dolist (arg args) (unless (equal (car arg) "body") (message-position-on-field (capitalize (car arg))) - (insert (replace-regexp-in-string + (insert (string-replace "\r\n" "\n" - (mapconcat #'identity (reverse (cdr arg)) ", ") nil t)))) + (mapconcat #'identity (reverse (cdr arg)) ", "))))) (when (assoc "body" args) (message-goto-body) (dolist (body (cdr (assoc "body" args))) diff --git a/lisp/gnus/mml-sec.el b/lisp/gnus/mml-sec.el index 15157e6fbc8..b49793509fc 100644 --- a/lisp/gnus/mml-sec.el +++ b/lisp/gnus/mml-sec.el @@ -1022,7 +1022,7 @@ Returns non-nil if the user has chosen to use SENDER." (if (eq 'OpenPGP protocol) (epg-sign-string context (buffer-string) mode) (epg-sign-string context - (replace-regexp-in-string + (string-replace "\n" "\r\n" (buffer-string)) t)) mml-secure-secret-key-id-list nil) diff --git a/lisp/gnus/mml-smime.el b/lisp/gnus/mml-smime.el index 5c133e680af..959de0902e2 100644 --- a/lisp/gnus/mml-smime.el +++ b/lisp/gnus/mml-smime.el @@ -404,7 +404,7 @@ Content-Disposition: attachment; filename=smime.p7m nil t))))) (mm-sec-error 'gnus-info "Corrupted") (throw 'error handle)) - (setq part (replace-regexp-in-string "\n" "\r\n" part) + (setq part (string-replace "\n" "\r\n" part) context (epg-make-context 'CMS)) (condition-case error ;; (setq plain diff --git a/lisp/gnus/mml2015.el b/lisp/gnus/mml2015.el index 1af7d10d055..8c40fc79f00 100644 --- a/lisp/gnus/mml2015.el +++ b/lisp/gnus/mml2015.el @@ -863,7 +863,7 @@ If set, it overrides the setting of `mml2015-sign-with-sender'." nil t)))) (mm-sec-error 'gnus-info "Corrupted") (throw 'error handle)) - (setq part (replace-regexp-in-string "\n" "\r\n" part) + (setq part (string-replace "\n" "\r\n" part) signature (mm-get-part signature) context (epg-make-context)) (condition-case error diff --git a/lisp/gnus/nnmaildir.el b/lisp/gnus/nnmaildir.el index 4867455393a..372df64e2e5 100644 --- a/lisp/gnus/nnmaildir.el +++ b/lisp/gnus/nnmaildir.el @@ -637,13 +637,11 @@ This variable is set by `nnmaildir-request-article'.") (funcall func (cdr entry))))))) (defun nnmaildir--system-name () - (replace-regexp-in-string + (string-replace ":" "\\072" - (replace-regexp-in-string + (string-replace "/" "\\057" - (replace-regexp-in-string "\\\\" "\\134" (system-name) nil 'literal) - nil 'literal) - nil 'literal)) + (string-replace "\\" "\\134" (system-name))))) (defun nnmaildir-request-type (_group &optional _article) 'mail) @@ -937,9 +935,9 @@ This variable is set by `nnmaildir-request-article'.") (setq pgname (nnmaildir--pgname nnmaildir--cur-server gname) ro (nnmaildir--param pgname 'read-only)) - (insert (replace-regexp-in-string + (insert (string-replace " " "\\ " - (nnmaildir--grp-name group) nil t) + (nnmaildir--grp-name group)) " ") (princ (nnmaildir--group-maxnum nnmaildir--cur-server group) nntp-server-buffer) @@ -968,7 +966,7 @@ This variable is set by `nnmaildir-request-article'.") (princ (nnmaildir--group-maxnum nnmaildir--cur-server group) nntp-server-buffer) (insert " " - (replace-regexp-in-string " " "\\ " gname nil t) + (string-replace " " "\\ " gname) "\n"))))) 'group) @@ -1098,7 +1096,7 @@ This variable is set by `nnmaildir-request-article'.") (insert " ") (princ (nnmaildir--group-maxnum nnmaildir--cur-server group) nntp-server-buffer) - (insert " " (replace-regexp-in-string " " "\\ " gname nil t) "\n") + (insert " " (string-replace " " "\\ " gname) "\n") t)))) (defun nnmaildir-request-create-group (gname &optional server _args) @@ -1262,7 +1260,7 @@ This variable is set by `nnmaildir-request-article'.") (insert "\t" (nnmaildir--nov-get-beg nov) "\t" (nnmaildir--art-msgid article) "\t" (nnmaildir--nov-get-mid nov) "\tXref: nnmaildir " - (replace-regexp-in-string " " "\\ " gname nil t) ":") + (string-replace " " "\\ " gname) ":") (princ num nntp-server-buffer) (insert "\t" (nnmaildir--nov-get-end nov) "\n")))) (catch 'return diff --git a/lisp/gnus/nnrss.el b/lisp/gnus/nnrss.el index a40fa88631f..8cd8cbe84f1 100644 --- a/lisp/gnus/nnrss.el +++ b/lisp/gnus/nnrss.el @@ -785,7 +785,7 @@ It is useful when `(setq nnrss-use-local t)'." (nnrss-node-just-text node) node)) (cleaned-text (if text - (replace-regexp-in-string + (string-replace "\r\n" "\n" (replace-regexp-in-string "^[\000-\037\177]+\\|^ +\\| +$" "" diff --git a/lisp/gnus/spam-report.el b/lisp/gnus/spam-report.el index a4234f84001..5fa280ea058 100644 --- a/lisp/gnus/spam-report.el +++ b/lisp/gnus/spam-report.el @@ -159,7 +159,7 @@ submitted at once. Internal variable.") rpt-host (concat "/" - (replace-regexp-in-string + (string-replace "/" ":" (replace-regexp-in-string "^.*article.gmane.org/" "" @@ -224,7 +224,7 @@ the function specified by `spam-report-url-ping-function'." (defcustom spam-report-user-mail-address (and (stringp user-mail-address) - (replace-regexp-in-string "@" "" user-mail-address)) + (string-replace "@" "" user-mail-address)) "Mail address of this user used for spam reports to Gmane. This is initialized based on `user-mail-address'." :type '(choice string diff --git a/lisp/ibuffer.el b/lisp/ibuffer.el index 9088f31053b..6c0180590b9 100644 --- a/lisp/ibuffer.el +++ b/lisp/ibuffer.el @@ -1719,7 +1719,7 @@ If point is on a group name, this function operates on that group." (ibuffer-buffer-name-face buffer mark)))) (if (not (seq-position string ?\n)) string - (replace-regexp-in-string + (string-replace "\n" (propertize "^J" 'font-lock-face 'escape-glyph) string)))) (define-ibuffer-column size diff --git a/lisp/image-dired.el b/lisp/image-dired.el index 2509ecf8f82..74985b9e56d 100644 --- a/lisp/image-dired.el +++ b/lisp/image-dired.el @@ -704,7 +704,7 @@ Increase at own risk.") (thumb (cdr (assq ?t spec)))) (rename-file nq8 thumb t))) (message "command %S %s" (process-command process) - (replace-regexp-in-string "\n" "" status))))) + (string-replace "\n" "" status))))) process)) (defun image-dired-pngcrush-thumb (spec) @@ -726,7 +726,7 @@ Increase at own risk.") (unless (and (eq (process-status process) 'exit) (zerop (process-exit-status process))) (message "command %S %s" (process-command process) - (replace-regexp-in-string "\n" "" status))) + (string-replace "\n" "" status))) (when (memq (process-status process) '(exit signal)) (let ((temp (cdr (assq ?q spec)))) (delete-file temp))))) @@ -744,7 +744,7 @@ Increase at own risk.") (unless (and (eq (process-status process) 'exit) (zerop (process-exit-status process))) (message "command %S %s" (process-command process) - (replace-regexp-in-string "\n" "" status))))) + (string-replace "\n" "" status))))) process)) (defun image-dired-create-thumb-1 (original-file thumbnail-file) @@ -794,7 +794,7 @@ Increase at own risk.") (zerop (process-exit-status process)))) (message "Thumb could not be created for %s: %s" (abbreviate-file-name original-file) - (replace-regexp-in-string "\n" "" status)) + (string-replace "\n" "" status)) (set-file-modes thumbnail-file #o600) (clear-image-cache thumbnail-file) ;; PNG thumbnail has been created since we are diff --git a/lisp/info.el b/lisp/info.el index b65728ba41b..1c477a7082f 100644 --- a/lisp/info.el +++ b/lisp/info.el @@ -1732,14 +1732,14 @@ escaped (\\\",\\\\)." (concat " (" (if (stringp Info-current-file) - (replace-regexp-in-string + (string-replace "%" "%%" (file-name-sans-extension (file-name-nondirectory Info-current-file))) (format "*%S*" Info-current-file)) ") " (if Info-current-node - (propertize (replace-regexp-in-string + (propertize (string-replace "%" "%%" Info-current-node) 'face 'mode-line-buffer-id 'help-echo diff --git a/lisp/international/mule-cmds.el b/lisp/international/mule-cmds.el index 55accf5beee..71e2653ffe9 100644 --- a/lisp/international/mule-cmds.el +++ b/lisp/international/mule-cmds.el @@ -2166,7 +2166,7 @@ See `set-language-info-alist' for use in programs." (let ((str (eval (get-language-info language-name 'sample-text)))) (if (stringp str) (insert "Sample text:\n " - (replace-regexp-in-string "\n" "\n " str) + (string-replace "\n" "\n " str) "\n\n"))) (error nil)) (let ((input-method (get-language-info language-name 'input-method)) diff --git a/lisp/mail/rfc2231.el b/lisp/mail/rfc2231.el index 6fb4502b23b..db34fd2cb9e 100644 --- a/lisp/mail/rfc2231.el +++ b/lisp/mail/rfc2231.el @@ -63,7 +63,7 @@ must never cause a Lisp error." (let (mod) (when (and (string-match "\\\\\"" string) (not (string-match "\\`\"\\|[^\\]\"" string))) - (setq string (replace-regexp-in-string "\\\\\"" "\"" string) + (setq string (string-replace "\\\"" "\"" string) mod t)) (when (and (string-match "\\\\(" string) (string-match "\\\\)" string) diff --git a/lisp/mail/rfc2368.el b/lisp/mail/rfc2368.el index 553f3cc3a54..b96f15d3e68 100644 --- a/lisp/mail/rfc2368.el +++ b/lisp/mail/rfc2368.el @@ -91,7 +91,7 @@ Note: make sure MAILTO-URL has been \"unhtmlized\" (e.g., & -> &), before calling this function." (let ((case-fold-search t) prequery query headers-alist) - (setq mailto-url (replace-regexp-in-string "\n" " " mailto-url)) + (setq mailto-url (string-replace "\n" " " mailto-url)) (if (string-match rfc2368-mailto-regexp mailto-url) (progn (setq prequery diff --git a/lisp/mail/rmail.el b/lisp/mail/rmail.el index e479a8e9b4a..8a38337773e 100644 --- a/lisp/mail/rmail.el +++ b/lisp/mail/rmail.el @@ -1960,7 +1960,7 @@ Value is the size of the newly read mail after conversion." (file-name-nondirectory (if (memq system-type '(windows-nt cygwin ms-dos)) ;; cannot have colons in file name - (replace-regexp-in-string ":" "-" file) + (string-replace ":" "-" file) file))) ;; Use the directory of this rmail file ;; because it's a nuisance to use the homedir @@ -3374,7 +3374,7 @@ The idea is to match it against simplified subjects of other messages." ;; Hide commas so it will work ok if parsed as a comma-separated list ;; of regexps. (setq subject - (replace-regexp-in-string "," "\054" subject t t)) + (string-replace "," "\054" subject)) (concat "\\`" subject "\\'"))) (defun rmail-next-same-subject (n) diff --git a/lisp/mail/rmailout.el b/lisp/mail/rmailout.el index eb8590f1f73..4c23686909c 100644 --- a/lisp/mail/rmailout.el +++ b/lisp/mail/rmailout.el @@ -678,9 +678,9 @@ than appending to it. Deletes the message after writing if (or (mail-fetch-field "Subject") rmail-default-body-file))) (setq default-file - (replace-regexp-in-string ":" "-" default-file)) + (string-replace ":" "-" default-file)) (setq default-file - (replace-regexp-in-string " " "-" default-file)) + (string-replace " " "-" default-file)) (list (setq rmail-default-body-file (read-file-name "Output message body to file: " diff --git a/lisp/mail/undigest.el b/lisp/mail/undigest.el index bf57ed6fa6f..0760a477296 100644 --- a/lisp/mail/undigest.el +++ b/lisp/mail/undigest.el @@ -125,7 +125,7 @@ See rmail-digest-methods." ;; Undo masking of separators inside digestified messages (goto-char (point-min)) (while (search-forward - (replace-regexp-in-string "\n-" "\n " separator) nil t) + (string-replace "\n-" "\n " separator) nil t) (replace-match separator)) ;; Return the list of marker pairs (nreverse result)))))) diff --git a/lisp/man.el b/lisp/man.el index 9b941a2b3d2..54b6ffe9836 100644 --- a/lisp/man.el +++ b/lisp/man.el @@ -802,7 +802,7 @@ POS defaults to `point'." ;; added by troff, and remove it. (or (not (eq (string-to-char (substring 1st-part -1)) ?-)) (string-match-p "-" (substring 1st-part 0 -1)) - (setq word (replace-regexp-in-string "-" "" word)))) + (setq word (string-replace "-" "" word)))) ;; Make sure the section number gets included by the code below. (goto-char (match-end 1))) (when (string-match "[-._‐]+$" word) diff --git a/lisp/mouse.el b/lisp/mouse.el index 89e5d7c48a3..cf7c17be28f 100644 --- a/lisp/mouse.el +++ b/lisp/mouse.el @@ -180,7 +180,7 @@ items `Turn Off' and `Help'." `(keymap ,(format "%s - %s" indicator (capitalize - (replace-regexp-in-string + (string-replace "-" " " (format "%S" minor-mode)))) (turn-off menu-item "Turn off minor mode" ,mm-fun) (help menu-item "Help for minor mode" diff --git a/lisp/mpc.el b/lisp/mpc.el index ab572aa539a..e04ffa49747 100644 --- a/lisp/mpc.el +++ b/lisp/mpc.el @@ -214,8 +214,8 @@ defaults to 6600 and HOST defaults to localhost." (with-current-buffer "*MPC-debug*" (goto-char (point-max)) (insert-before-markers ;So it scrolls. - (replace-regexp-in-string "\n" "\n " - (apply #'format-message format args)) + (string-replace "\n" "\n " + (apply #'format-message format args)) "\n")))) (defun mpc--proc-filter (proc string) diff --git a/lisp/net/browse-url.el b/lisp/net/browse-url.el index 6d64100be17..f739cd72cc3 100644 --- a/lisp/net/browse-url.el +++ b/lisp/net/browse-url.el @@ -1644,7 +1644,7 @@ used instead of `browse-url-new-window-flag'." (insert "\n")) (goto-char (prog1 (point) - (insert (replace-regexp-in-string "\r\n" "\n" body)) + (insert (string-replace "\r\n" "\n" body)) (unless (bolp) (insert "\n")))))))) diff --git a/lisp/net/eww.el b/lisp/net/eww.el index eec3ec7ba8b..2a81d2e0c8c 100644 --- a/lisp/net/eww.el +++ b/lisp/net/eww.el @@ -779,7 +779,7 @@ Currently this means either text/html or application/xhtml+xml." (propertize "...: " 'face 'variable-pitch)))) (propertize "..." 'face 'variable-pitch))))))) - (replace-regexp-in-string + (string-replace "%" "%%" (format-spec eww-header-line-format diff --git a/lisp/net/newst-backend.el b/lisp/net/newst-backend.el index e623dab26df..dc541943587 100644 --- a/lisp/net/newst-backend.el +++ b/lisp/net/newst-backend.el @@ -610,7 +610,7 @@ This does NOT start the retrieval timers." (interactive) (let ((filename (read-string "Filename: " (concat feed ":_" - (replace-regexp-in-string + (string-replace " " "_" (newsticker--title item)) ".html")))) (with-temp-buffer diff --git a/lisp/net/rcirc.el b/lisp/net/rcirc.el index f11f36e8096..e7aec505b0b 100644 --- a/lisp/net/rcirc.el +++ b/lisp/net/rcirc.el @@ -800,7 +800,7 @@ When 0, do not auto-reconnect." (defun rcirc-sentinel (process sentinel) "Called when PROCESS receives SENTINEL." - (let ((sentinel (replace-regexp-in-string "\n" "" sentinel))) + (let ((sentinel (string-replace "\n" "" sentinel))) (rcirc-debug process (format "SENTINEL: %S %S\n" process sentinel)) (with-rcirc-process-buffer process (dolist (buffer (cons nil (mapcar 'cdr rcirc-buffer-alist))) diff --git a/lisp/net/soap-client.el b/lisp/net/soap-client.el index 821ef4af8e0..f5480afb698 100644 --- a/lisp/net/soap-client.el +++ b/lisp/net/soap-client.el @@ -659,7 +659,7 @@ representing leap seconds." (if second (if second-fraction (let* ((second-fraction-significand - (replace-regexp-in-string "\\." "" second-fraction)) + (string-replace "." "" second-fraction)) (hertz (expt 10 (length second-fraction-significand))) (ticks (+ (* hertz (string-to-number second)) diff --git a/lisp/nxml/rng-cmpct.el b/lisp/nxml/rng-cmpct.el index 1314ade9e31..d820d1b99b5 100644 --- a/lisp/nxml/rng-cmpct.el +++ b/lisp/nxml/rng-cmpct.el @@ -100,7 +100,7 @@ Return a pattern." "Regular expression to match a single-quoted literal.") (defconst rng-c-literal-2-re - (replace-regexp-in-string "'" "\"" rng-c-literal-1-re) + (string-replace "'" "\"" rng-c-literal-1-re) "Regular expression to match a double-quoted literal.") (defconst rng-c-ncname-re "\\w+") diff --git a/lisp/nxml/xmltok.el b/lisp/nxml/xmltok.el index 9824eebbd8b..38bc2e141e6 100644 --- a/lisp/nxml/xmltok.el +++ b/lisp/nxml/xmltok.el @@ -479,7 +479,7 @@ and VALUE-END, otherwise a STRING giving the value." "[^<'&\r\n\t]*" (xmltok-g complex1 "[&\r\n\t][^<']*") opt "'")) - (lit2 (cons (replace-regexp-in-string "'" "\"" (car lit1)) + (lit2 (cons (string-replace "'" "\"" (car lit1)) '(complex2))) (literal (xmltok-g literal lit1 or lit2)) (name (xmltok+ open (xmltok-g xmlns "xmlns") or ncname close diff --git a/lisp/obsolete/nnir.el b/lisp/obsolete/nnir.el index 40a8ec57b98..caeca988810 100644 --- a/lisp/obsolete/nnir.el +++ b/lisp/obsolete/nnir.el @@ -920,10 +920,10 @@ Tested with swish-e-2.0.1 on Windows NT 4.0." ;; eliminate all ".", "/", "\" from beginning. Always matches. (string-match "^[./\\]*\\(.*\\)$" dirnam) ;; "/" -> "." - (setq group (replace-regexp-in-string + (setq group (string-replace "/" "." (match-string 1 dirnam))) ;; Windows "\\" -> "." - (setq group (replace-regexp-in-string "\\\\" "." group)) + (setq group (string-replace "\\" "." group)) (push (vector (gnus-group-full-name group server) (string-to-number artno) @@ -996,7 +996,7 @@ Tested with swish-e-2.0.1 on Windows NT 4.0." (when (string-match prefix dirnam) (setq dirnam (replace-match "" t t dirnam))) (push (vector (gnus-group-full-name - (replace-regexp-in-string "/" "." dirnam) server) + (string-replace "/" "." dirnam) server) (string-to-number artno) (string-to-number score)) artlist)) @@ -1205,9 +1205,9 @@ construct path: search terms (see the variable group (if (file-directory-p (setq group - (replace-regexp-in-string - "\\." "/" - group nil t))) + (string-replace + "." "/" + group))) group)))))) (unless group (error "Cannot locate directory for group")) diff --git a/lisp/play/dunnet.el b/lisp/play/dunnet.el index c3be029a658..3bb8bf0c82b 100644 --- a/lisp/play/dunnet.el +++ b/lisp/play/dunnet.el @@ -2373,7 +2373,7 @@ Also prints current score to let user know he has scored." (dun-mprincl "Incorrect."))) (let (varname epoint afterq i value) - (setq varname (replace-regexp-in-string " " "" (substring line 0 esign))) + (setq varname (string-replace " " "" (substring line 0 esign))) (if (or (= (length varname) 0) (< (- (length line) esign) 2)) (progn diff --git a/lisp/play/handwrite.el b/lisp/play/handwrite.el index cc058230751..2aec408e11b 100644 --- a/lisp/play/handwrite.el +++ b/lisp/play/handwrite.el @@ -200,7 +200,7 @@ Variables: `handwrite-linespace' (default 12) (concat "\\\\" (cdr trans)) line))) (switch-to-buffer ps-buf-name) - (insert (replace-regexp-in-string "\n" "" line)) + (insert (string-replace "\n" "" line)) (message "write write write...") (setq ps-ypos (+ ps-ypos handwrite-linespace)) (end-of-line) diff --git a/lisp/proced.el b/lisp/proced.el index d1a243df8e0..2fafdcc58e5 100644 --- a/lisp/proced.el +++ b/lisp/proced.el @@ -1389,7 +1389,7 @@ The return string is always 6 characters wide." (defun proced-format-args (args) "Format attribute ARGS. Replace newline characters by \"^J\" (two characters)." - (replace-regexp-in-string "\n" "^J" args)) + (string-replace "\n" "^J" args)) (defun proced-format (process-alist format) "Display PROCESS-ALIST using FORMAT." diff --git a/lisp/profiler.el b/lisp/profiler.el index 8145e51d75d..4c427692cb8 100644 --- a/lisp/profiler.el +++ b/lisp/profiler.el @@ -499,7 +499,7 @@ RET: expand or collapse")) (defun profiler-report-header-line-format (fmt &rest args) (let* ((header (apply #'profiler-format fmt args)) - (escaped (replace-regexp-in-string "%" "%%" header))) + (escaped (string-replace "%" "%%" header))) (concat (propertize " " 'display '(space :align-to 0) diff --git a/lisp/progmodes/gdb-mi.el b/lisp/progmodes/gdb-mi.el index b9c8305bed0..97596d0d278 100644 --- a/lisp/progmodes/gdb-mi.el +++ b/lisp/progmodes/gdb-mi.el @@ -1963,7 +1963,7 @@ commands to be prefixed by \"-interpreter-exec console\".") The string is enclosed in double quotes. All embedded quotes, newlines, and backslashes are preceded with a backslash." (setq string (replace-regexp-in-string "\\([\"\\]\\)" "\\\\\\&" string)) - (setq string (replace-regexp-in-string "\n" "\\n" string t t)) + (setq string (string-replace "\n" "\\n" string)) (concat "\"" string "\"")) (defun gdb-input (command handler-function &optional trigger-name) diff --git a/lisp/progmodes/make-mode.el b/lisp/progmodes/make-mode.el index 4d277755aeb..df17b87c013 100644 --- a/lisp/progmodes/make-mode.el +++ b/lisp/progmodes/make-mode.el @@ -257,7 +257,7 @@ not be enclosed in { } or ( )." "Regex used to highlight makepp rule action lines in font lock mode.") (defconst makefile-bsdmake-rule-action-regex - (replace-regexp-in-string "-@" "-+@" makefile-rule-action-regex) + (string-replace "-@" "-+@" makefile-rule-action-regex) "Regex used to highlight BSD rule action lines in font lock mode.") ;; Note that the first and second subexpression is used by font lock. Note @@ -358,11 +358,10 @@ not be enclosed in { } or ( )." ,@(if keywords ;; Fontify conditionals and includes. `((,(concat "^\\(?: [ \t]*\\)?" - (replace-regexp-in-string + (string-replace " " "[ \t]+" (if (eq (car keywords) t) - (replace-regexp-in-string "-" "[_-]" - (regexp-opt (cdr keywords) t)) + (string-replace "-" "[_-]" (regexp-opt (cdr keywords) t)) (regexp-opt keywords t))) "\\>[ \t]*\\([^: \t\n#]*\\)") (1 font-lock-keyword-face) (2 font-lock-variable-name-face)))) diff --git a/lisp/progmodes/prolog.el b/lisp/progmodes/prolog.el index 0b520e39074..2e23c2e2cab 100644 --- a/lisp/progmodes/prolog.el +++ b/lisp/progmodes/prolog.el @@ -2277,7 +2277,7 @@ between them)." ;(goto-char beg) (if (search-forward-regexp "^[ \t]*\\(%+\\|\\*+\\|/\\*+\\)[ \t]*" end t) - (replace-regexp-in-string "/" " " (buffer-substring beg (point))) + (string-replace "/" " " (buffer-substring beg (point))) (beginning-of-line) (when (search-forward-regexp "^[ \t]+" end t) (buffer-substring beg (point))))))))) diff --git a/lisp/progmodes/ruby-mode.el b/lisp/progmodes/ruby-mode.el index 01fb044161b..74b48ca4bde 100644 --- a/lisp/progmodes/ruby-mode.el +++ b/lisp/progmodes/ruby-mode.el @@ -1788,8 +1788,8 @@ If the result is do-end block, it will always be multiline." (buffer-substring-no-properties (1+ min) (1- max)))) (setq content (if (equal string-quote "'") - (replace-regexp-in-string "\\\\\"" "\"" (replace-regexp-in-string "\\(\\`\\|[^\\]\\)'" "\\1\\\\'" content)) - (replace-regexp-in-string "\\\\'" "'" (replace-regexp-in-string "\\(\\`\\|[^\\]\\)\"" "\\1\\\\\"" content)))) + (string-replace "\\\"" "\"" (replace-regexp-in-string "\\(\\`\\|[^\\]\\)'" "\\1\\\\'" content)) + (string-replace "\\'" "'" (replace-regexp-in-string "\\(\\`\\|[^\\]\\)\"" "\\1\\\\\"" content)))) (let ((orig-point (point))) (delete-region min max) (insert diff --git a/lisp/progmodes/sql.el b/lisp/progmodes/sql.el index f144549cf6d..b9012166a52 100644 --- a/lisp/progmodes/sql.el +++ b/lisp/progmodes/sql.el @@ -3843,7 +3843,7 @@ to avoid deleting non-prompt output." (defun sql-remove-tabs-filter (str) "Replace tab characters with spaces." - (replace-regexp-in-string "\t" " " str nil t)) + (string-replace "\t" " " str)) (defun sql-toggle-pop-to-buffer-after-send-region (&optional value) "Toggle `sql-pop-to-buffer-after-send-region'. @@ -3864,7 +3864,7 @@ If given the optional parameter VALUE, sets "If non-nil, display messages related to the use of redirection.") (defun sql-str-literal (s) - (concat "'" (replace-regexp-in-string "[']" "''" s) "'")) + (concat "'" (string-replace "[']" "''" s) "'")) (defun sql-redirect (sqlbuf command &optional outbuf save-prior) "Execute the SQL command and send output to OUTBUF. diff --git a/lisp/progmodes/which-func.el b/lisp/progmodes/which-func.el index 02a8d72758c..eb170baa5d8 100644 --- a/lisp/progmodes/which-func.el +++ b/lisp/progmodes/which-func.el @@ -175,7 +175,7 @@ and you want to simplify them for the mode line (defvar which-func-table (make-hash-table :test 'eq :weakness 'key)) (defconst which-func-current - '(:eval (replace-regexp-in-string + '(:eval (string-replace "%" "%%" (or (gethash (selected-window) which-func-table) which-func-unknown)))) diff --git a/lisp/replace.el b/lisp/replace.el index ee46286a75f..c67877efd5d 100644 --- a/lisp/replace.el +++ b/lisp/replace.el @@ -213,7 +213,7 @@ wants to replace FROM with TO." (when query-replace-from-to-separator ;; Check if the first non-whitespace char is displayable (if (char-displayable-p - (string-to-char (replace-regexp-in-string + (string-to-char (string-replace " " "" query-replace-from-to-separator))) query-replace-from-to-separator " -> "))) @@ -2101,7 +2101,7 @@ See also `multi-occur'." ;; Add non-numeric prefix to all non-first lines ;; of multi-line matches. (concat - (replace-regexp-in-string + (string-replace "\n" (if prefix-face (propertize @@ -2506,12 +2506,10 @@ a string, it is first passed through `prin1-to-string' with the `noescape' argument set. `match-data' is preserved across the call." - (save-match-data - (replace-regexp-in-string "\\\\" "\\\\" - (if (stringp replacement) - replacement - (prin1-to-string replacement t)) - t t))) + (string-replace "\\" "\\\\" + (if (stringp replacement) + replacement + (prin1-to-string replacement t)))) (defun replace-loop-through-replacements (data count) ;; DATA is a vector containing the following values: diff --git a/lisp/select.el b/lisp/select.el index eaa74cebd80..15e171c13f9 100644 --- a/lisp/select.el +++ b/lisp/select.el @@ -496,7 +496,7 @@ two markers or an overlay. Otherwise, it is nil." (error "Unknown selection type: %S" type))))) ;; Most programs are unable to handle NUL bytes in strings. - (setq str (replace-regexp-in-string "\0" "\\0" str t t)) + (setq str (string-replace "\0" "\\0" str)) (setq next-selection-coding-system nil) (cons type str)))) diff --git a/lisp/ses.el b/lisp/ses.el index ca515f829dc..81c27144a54 100644 --- a/lisp/ses.el +++ b/lisp/ses.el @@ -3357,7 +3357,7 @@ is non-nil. Newlines and tabs in the export text are escaped." (push "'" result) (setq item (cadr item))) (setq item (ses-prin1 item)) - (setq item (replace-regexp-in-string "\t" "\\\\t" item)) + (setq item (string-replace "\t" "\\t" item)) (push item result) (cond ((< col maxcol) diff --git a/lisp/subr.el b/lisp/subr.el index b8286600664..87298b5cfde 100644 --- a/lisp/subr.el +++ b/lisp/subr.el @@ -3681,7 +3681,7 @@ See Info node `(elisp)Security Considerations'." "''" ;; Quote everything except POSIX filename characters. ;; This should be safe enough even for really weird shells. - (replace-regexp-in-string + (string-replace "\n" "'\n'" (replace-regexp-in-string "[^-0-9a-zA-Z_./\n]" "\\\\\\&" argument)))) )) diff --git a/lisp/term/pc-win.el b/lisp/term/pc-win.el index 8cff2ceaeec..9e7b360b9c6 100644 --- a/lisp/term/pc-win.el +++ b/lisp/term/pc-win.el @@ -290,7 +290,7 @@ This is used by `msdos-show-help'.") (not cursor-in-echo-area)) ;Don't overwrite a prompt. (cond ((stringp help) - (setq help (replace-regexp-in-string "\n" ", " help)) + (setq help (string-replace "\n" ", " help)) (unless (or msdos-previous-message (string-equal help (current-message)) (and (stringp msdos-last-help-message) diff --git a/lisp/term/w32-win.el b/lisp/term/w32-win.el index 6b849164aec..80afcb36040 100644 --- a/lisp/term/w32-win.el +++ b/lisp/term/w32-win.el @@ -410,7 +410,7 @@ See the documentation of `create-fontset-from-fontset-spec' for the format.") ;;; Fix interface to (X-specific) mouse.el (defun w32--set-selection (type value) (if (eq type 'CLIPBOARD) - (w32-set-clipboard-data (replace-regexp-in-string "\0" "\\0" value t t)) + (w32-set-clipboard-data (string-replace "\0" "\\0" value)) (put 'x-selections (or type 'PRIMARY) value))) (defun w32--get-selection (&optional type data-type) diff --git a/lisp/term/xterm.el b/lisp/term/xterm.el index 8bcae37afe4..868b33ea9c5 100644 --- a/lisp/term/xterm.el +++ b/lisp/term/xterm.el @@ -1015,10 +1015,9 @@ hitting screen's max DCS length." 'terminal-init-screen)) (bytes (encode-coding-string data 'utf-8-unix)) (base-64 (if screen - (replace-regexp-in-string + (string-replace "\n" "\e\\\eP" - (base64-encode-string bytes) - :fixedcase :literal) + (base64-encode-string bytes)) (base64-encode-string bytes :no-line-break))) (length (length base-64))) (if (> length xterm-max-cut-length) diff --git a/lisp/textmodes/picture.el b/lisp/textmodes/picture.el index 1368af01bac..1d5d1caeabc 100644 --- a/lisp/textmodes/picture.el +++ b/lisp/textmodes/picture.el @@ -449,8 +449,8 @@ If no such character is found, move to beginning of line." (progn (beginning-of-line) (skip-chars-backward - (concat "^" (replace-regexp-in-string - "\\\\" "\\\\" picture-tab-chars nil t)) + (concat "^" (string-replace + "\\" "\\\\" picture-tab-chars)) (point-min)) (not (bobp)))) (move-to-column target)) diff --git a/lisp/thumbs.el b/lisp/thumbs.el index 5710b8c353b..4c863883ba4 100644 --- a/lisp/thumbs.el +++ b/lisp/thumbs.el @@ -434,10 +434,10 @@ Open another window." (defun thumbs-call-setroot-command (img) "Call the setroot program for IMG." (run-hooks 'thumbs-before-setroot-hook) - (shell-command (replace-regexp-in-string - "\\*" + (shell-command (string-replace + "*" (shell-quote-argument (expand-file-name img)) - thumbs-setroot-command nil t)) + thumbs-setroot-command)) (run-hooks 'thumbs-after-setroot-hook)) (defun thumbs-set-image-at-point-to-root-window () diff --git a/lisp/tooltip.el b/lisp/tooltip.el index 03d9f54ea6c..23b67ee2cab 100644 --- a/lisp/tooltip.el +++ b/lisp/tooltip.el @@ -346,7 +346,7 @@ It is also called if Tooltip mode is on, for text-only displays." (not cursor-in-echo-area)) ;Don't overwrite a prompt. (cond ((stringp help) - (setq help (replace-regexp-in-string "\n" ", " help)) + (setq help (string-replace "\n" ", " help)) (unless (or tooltip-previous-message (equal-including-properties help (current-message)) (and (stringp tooltip-help-message) diff --git a/lisp/transient.el b/lisp/transient.el index 5f66a13094b..4087a0c68a6 100644 --- a/lisp/transient.el +++ b/lisp/transient.el @@ -3064,18 +3064,18 @@ Optional support for popup buttons is also implemented here." ((equal (seq-take seq len) transient--redisplay-key) (let ((pre (key-description (vconcat (seq-take seq len)))) (suf (key-description (vconcat (seq-drop seq len))))) - (setq pre (replace-regexp-in-string "RET" "C-m" pre t)) - (setq pre (replace-regexp-in-string "TAB" "C-i" pre t)) - (setq suf (replace-regexp-in-string "RET" "C-m" suf t)) - (setq suf (replace-regexp-in-string "TAB" "C-i" suf t)) + (setq pre (string-replace "RET" "C-m" pre)) + (setq pre (string-replace "TAB" "C-i" pre)) + (setq suf (string-replace "RET" "C-m" suf)) + (setq suf (string-replace "TAB" "C-i" suf)) ;; We use e.g. "-k" instead of the more correct "- k", ;; because the former is prettier. If we did that in ;; the definition, then we want to drop the space that ;; is reinserted above. False-positives are possible ;; for silly bindings like "-C-c C-c". (unless (string-match-p " " key) - (setq pre (replace-regexp-in-string " " "" pre)) - (setq suf (replace-regexp-in-string " " "" suf))) + (setq pre (string-replace " " "" pre)) + (setq suf (string-replace " " "" suf))) (concat (propertize pre 'face 'default) (and (string-prefix-p (concat pre " ") key) " ") (transient--colorize-key suf cmd) diff --git a/lisp/url/url-mailto.el b/lisp/url/url-mailto.el index 29c2780121a..4fd631d2955 100644 --- a/lisp/url/url-mailto.el +++ b/lisp/url/url-mailto.el @@ -105,7 +105,7 @@ (goto-char (point-max))) (insert (mapconcat (lambda (string) - (replace-regexp-in-string "\r\n" "\n" string)) + (string-replace "\r\n" "\n" string)) (cdar args) "\n"))) (url-mail-goto-field (caar args)) ;; (setq func (intern-soft (concat "mail-" (caar args)))) diff --git a/lisp/vc/log-edit.el b/lisp/vc/log-edit.el index 4a44787bb03..46e9c97eb0a 100644 --- a/lisp/vc/log-edit.el +++ b/lisp/vc/log-edit.el @@ -974,8 +974,8 @@ Return non-nil if it is." (not (looking-at (format ".+ .+ <%s>" (regexp-quote mail)))) (looking-at ".+ \\(.+ <.+>\\) *\\((tiny change)\\)?")) - (let ((author (replace-regexp-in-string " " " " - (match-string 1)))) + (let ((author (string-replace " " " " + (match-string 1)))) (unless (and log-edit-author (string-match (regexp-quote author) (car log-edit-author))) diff --git a/lisp/vc/vc-bzr.el b/lisp/vc/vc-bzr.el index de5a90dc602..5144b5d0bbb 100644 --- a/lisp/vc/vc-bzr.el +++ b/lisp/vc/vc-bzr.el @@ -467,7 +467,7 @@ in the branch repository (or whose status not be determined)." ;; Erase the status text that matched. (delete-region (match-beginning 0) (match-end 0)) (setq status - (intern (replace-regexp-in-string " " "" statusword))))) + (intern (string-replace " " "" statusword))))) (when status (goto-char (point-min)) (skip-chars-forward " \n\t") ;Throw away spaces. diff --git a/lisp/vc/vc-hg.el b/lisp/vc/vc-hg.el index c9c1e91d483..4a64caa36b8 100644 --- a/lisp/vc/vc-hg.el +++ b/lisp/vc/vc-hg.el @@ -851,8 +851,8 @@ if we don't understand a construct, we signal (push "\\[" parts)) (t (let ((x (substring glob i j))) - (setf x (replace-regexp-in-string - "\\\\" "\\\\" x t t)) + (setf x (string-replace + "\\" "\\\\" x)) (setf i (1+ j)) (cond ((eq (aref x 0) ?!) (setf (aref x 0) ?^)) diff --git a/lisp/vc/vc-svn.el b/lisp/vc/vc-svn.el index c30920dd157..544a6c769fc 100644 --- a/lisp/vc/vc-svn.el +++ b/lisp/vc/vc-svn.el @@ -192,7 +192,7 @@ switches." (let ((state (cdr (assq (aref (match-string 1) 0) state-map))) (propstat (cdr (assq (aref (match-string 2) 0) state-map))) (filename (if (memq system-type '(windows-nt ms-dos)) - (replace-regexp-in-string "\\\\" "/" (match-string 4)) + (string-replace "\\" "/" (match-string 4)) (match-string 4)))) (and (memq propstat '(conflict edited)) (not (eq state 'conflict)) ; conflict always wins diff --git a/lisp/xdg.el b/lisp/xdg.el index 0bdfd114c48..e5165bbd86a 100644 --- a/lisp/xdg.el +++ b/lisp/xdg.el @@ -208,8 +208,8 @@ Optional argument GROUP defaults to the string \"Desktop Entry\"." "Partition VALUE into elements delimited by unescaped semicolons." (let (res) (setq value (string-trim-left value)) - (dolist (x (split-string (replace-regexp-in-string "\\\\;" "\0" value) ";")) - (push (replace-regexp-in-string "\0" ";" x) res)) + (dolist (x (split-string (string-replace "\\;" "\0" value) ";")) + (push (string-replace "\0" ";" x) res)) (when (null (string-match-p "[^[:blank:]]" (car res))) (pop res)) (nreverse res))) diff --git a/test/lisp/electric-tests.el b/test/lisp/electric-tests.el index 235c02f8e8b..ea856ab311c 100644 --- a/test/lisp/electric-tests.el +++ b/test/lisp/electric-tests.el @@ -146,7 +146,7 @@ The buffer's contents should %s: "") char (if (string= fixture expected-string) "stay" "become") - (replace-regexp-in-string "\n" "\\\\n" expected-string) + (string-replace "\n" "\\n" expected-string) expected-point))) `(ert-deftest ,(intern (format "electric-pair-%s-at-point-%s-in-%s%s" name diff --git a/test/lisp/term-tests.el b/test/lisp/term-tests.el index 503cb5d7aab..50ac370b5b5 100644 --- a/test/lisp/term-tests.el +++ b/test/lisp/term-tests.el @@ -56,7 +56,7 @@ first line\r next line\r\n")) (should (equal (term-test-screen-from-input 40 12 str) - (replace-regexp-in-string "\r" "" str))))) + (string-replace "\r" "" str))))) (ert-deftest term-carriage-return () (skip-unless (not (memq system-type '(windows-nt ms-dos)))) diff --git a/test/lisp/time-stamp-tests.el b/test/lisp/time-stamp-tests.el index 0d64320496d..4e6fbbba923 100644 --- a/test/lisp/time-stamp-tests.el +++ b/test/lisp/time-stamp-tests.el @@ -849,7 +849,7 @@ The functions in `pattern-mod' are composed left to right." (defun formatz-mod-del-colons (string) "Returns STRING with any colons removed." - (replace-regexp-in-string ":" "" string)) + (string-replace ":" "" string)) (defun formatz-mod-add-00 (string) "Returns STRING with \"00\" appended." diff --git a/test/lisp/wdired-tests.el b/test/lisp/wdired-tests.el index ba276e24d96..96a01fc2c7b 100644 --- a/test/lisp/wdired-tests.el +++ b/test/lisp/wdired-tests.el @@ -31,7 +31,7 @@ Partially modifying a file name should succeed." (let* ((test-dir (make-temp-file "test-dir-" t)) (test-file (concat (file-name-as-directory test-dir) "foo.c")) (replace "bar") - (new-file (replace-regexp-in-string "foo" replace test-file)) + (new-file (string-replace "foo" replace test-file)) (wdired-use-interactive-rename t)) (write-region "" nil test-file nil 'silent) (advice-add 'dired-query ; Don't ask confirmation to overwrite a file. @@ -109,7 +109,7 @@ wdired-mode." (let* ((test-dir (make-temp-file "test-dir-" t)) (test-file (concat (file-name-as-directory test-dir) "foo.c")) (replace "bar") - (new-file (replace-regexp-in-string "foo" replace test-file))) + (new-file (string-replace "foo" replace test-file))) (write-region "" nil test-file nil 'silent) (let ((buf (find-file-noselect test-dir))) (unwind-protect diff --git a/test/src/json-tests.el b/test/src/json-tests.el index 908945fcb08..8dc0a744aa0 100644 --- a/test/src/json-tests.el +++ b/test/src/json-tests.el @@ -252,7 +252,7 @@ Test with both unibyte and multibyte strings." (let* ((input "{ \"abc\" : [9, false] , \"def\" : null }") (output - (replace-regexp-in-string " " "" input))) + (string-replace " " "" input))) (should (equal (json-parse-string input :object-type 'plist :null-object :json-null -- cgit v1.2.3 From 3b7b181bded1bddb2505eda1224a5631cbf04c1b Mon Sep 17 00:00:00 2001 From: Mattias Engdegård Date: Mon, 9 Aug 2021 11:20:00 +0200 Subject: Use string-search instead of string-match[-p] `string-search` is easier to understand, less error-prone, much faster, does not pollute the regexp cache, and does not mutate global state. Use it where applicable and obviously safe (erring on the conservative side). * admin/authors.el (authors-canonical-file-name) (authors-scan-change-log): * lisp/apropos.el (apropos-command) (apropos-documentation-property, apropos-symbols-internal): * lisp/arc-mode.el (archive-arc-summarize) (archive-zoo-summarize): * lisp/calc/calc-aent.el (math-read-factor): * lisp/calc/calc-ext.el (math-read-big-expr) (math-format-nice-expr, math-format-number-fancy): * lisp/calc/calc-forms.el (math-read-angle-brackets): * lisp/calc/calc-graph.el (calc-graph-set-range): * lisp/calc/calc-keypd.el (calc-keypad-press): * lisp/calc/calc-lang.el (tex, latex, math-read-big-rec): * lisp/calc/calc-prog.el (calc-fix-token-name) (calc-user-define-permanent, math-define-exp): * lisp/calc/calc.el (calc-record, calcDigit-key) (calc-count-lines): * lisp/calc/calcalg2.el (calc-solve-for, calc-poly-roots) (math-do-integral): * lisp/calc/calcalg3.el (calc-find-root, calc-find-minimum) (calc-get-fit-variables): * lisp/cedet/ede/speedbar.el (ede-tag-expand): * lisp/cedet/semantic/java.el (semantic-java-expand-tag): * lisp/cedet/semantic/sb.el (semantic-sb-show-extra) (semantic-sb-expand-group): * lisp/cedet/semantic/wisent/python.el (semantic-python-instance-variable-p): * lisp/cus-edit.el (get): * lisp/descr-text.el (describe-text-sexp): * lisp/dired-aux.el (dired-compress-file): * lisp/dired-x.el (dired-make-relative-symlink): * lisp/dired.el (dired-glob-regexp): * lisp/dos-fns.el (dos-convert-standard-filename, dos-8+3-filename): * lisp/edmacro.el (edmacro-format-keys): * lisp/emacs-lisp/eieio-opt.el (eieio-sb-expand): * lisp/emacs-lisp/eieio-speedbar.el (eieio-speedbar-object-expand): * lisp/emacs-lisp/lisp-mnt.el (lm-keywords-list): * lisp/emacs-lisp/warnings.el (display-warning): * lisp/emulation/viper-ex.el (viper-ex-read-file-name) (ex-print-display-lines): * lisp/env.el (read-envvar-name, setenv): * lisp/epa-mail.el (epa-mail-encrypt): * lisp/epg.el (epg--start): * lisp/erc/erc-backend.el (erc-parse-server-response): * lisp/erc/erc-dcc.el (erc-dcc-member): * lisp/erc/erc-speedbar.el (erc-speedbar-expand-server) (erc-speedbar-expand-channel, erc-speedbar-expand-user): * lisp/erc/erc.el (erc-send-input): * lisp/eshell/em-glob.el (eshell-glob-entries): * lisp/eshell/esh-proc.el (eshell-needs-pipe-p): * lisp/eshell/esh-util.el (eshell-convert): * lisp/eshell/esh-var.el (eshell-envvar-names): * lisp/faces.el (x-resolve-font-name): * lisp/ffap.el (ffap-file-at-point): * lisp/files.el (wildcard-to-regexp, shell-quote-wildcard-pattern): * lisp/forms.el (forms--update): * lisp/frameset.el (frameset-filter-unshelve-param): * lisp/gnus/gnus-art.el (article-decode-charset): * lisp/gnus/gnus-kill.el (gnus-kill-parse-rn-kill-file): * lisp/gnus/gnus-mlspl.el (gnus-group-split-fancy): * lisp/gnus/gnus-msg.el (gnus-summary-resend-message-insert-gcc) (gnus-inews-insert-gcc): * lisp/gnus/gnus-rfc1843.el (rfc1843-decode-article-body): * lisp/gnus/gnus-search.el (gnus-search-indexed-parse-output) (gnus-search--complete-key-data): * lisp/gnus/gnus-spec.el (gnus-parse-simple-format): * lisp/gnus/gnus-sum.el (gnus-summary-refer-article): * lisp/gnus/gnus-util.el (gnus-extract-address-components) (gnus-newsgroup-directory-form): * lisp/gnus/gnus-uu.el (gnus-uu-grab-view): * lisp/gnus/gnus.el (gnus-group-native-p, gnus-short-group-name): * lisp/gnus/message.el (message-check-news-header-syntax) (message-make-message-id, message-user-mail-address) (message-make-fqdn, message-get-reply-headers, message-followup): * lisp/gnus/mm-decode.el (mm-dissect-buffer): * lisp/gnus/nnheader.el (nnheader-insert): * lisp/gnus/nnimap.el (nnimap-process-quirk) (nnimap-imap-ranges-to-gnus-ranges): * lisp/gnus/nnmaildir.el (nnmaildir--ensure-suffix): * lisp/gnus/nnmairix.el (nnmairix-determine-original-group-from-path): * lisp/gnus/nnrss.el (nnrss-match-macro): * lisp/gnus/nntp.el (nntp-find-group-and-number): * lisp/help-fns.el (help--symbol-completion-table-affixation): * lisp/help.el (help-function-arglist): * lisp/hippie-exp.el (he-concat-directory-file-name): * lisp/htmlfontify.el (hfy-relstub): * lisp/ido.el (ido-make-prompt, ido-complete, ido-copy-current-word) (ido-exhibit): * lisp/image/image-converter.el (image-convert-p): * lisp/info-xref.el (info-xref-docstrings): * lisp/info.el (Info-toc-build, Info-follow-reference) (Info-backward-node, Info-finder-find-node) (Info-speedbar-expand-node): * lisp/international/mule-diag.el (print-fontset-element): * lisp/language/korea-util.el (default-korean-keyboard): * lisp/linum.el (linum-after-change): * lisp/mail/ietf-drums.el (ietf-drums-parse-address): * lisp/mail/mail-utils.el (mail-dont-reply-to): * lisp/mail/rfc2047.el (rfc2047-encode-1, rfc2047-decode-string): * lisp/mail/rfc2231.el (rfc2231-parse-string): * lisp/mail/rmailkwd.el (rmail-set-label): * lisp/mail/rmailsum.el (rmail-header-summary): * lisp/mail/smtpmail.el (smtpmail-maybe-append-domain) (smtpmail-user-mail-address): * lisp/mail/uce.el (uce-reply-to-uce): * lisp/man.el (Man-default-man-entry): * lisp/mh-e/mh-alias.el (mh-alias-gecos-name) (mh-alias-minibuffer-confirm-address): * lisp/mh-e/mh-comp.el (mh-forwarded-letter-subject): * lisp/mh-e/mh-speed.el (mh-speed-parse-flists-output): * lisp/mh-e/mh-utils.el (mh-collect-folder-names-filter) (mh-folder-completion-function): * lisp/minibuffer.el (completion--make-envvar-table) (completion-file-name-table, completion-flex-try-completion) (completion-flex-all-completions): * lisp/mpc.el (mpc--proc-quote-string, mpc-cmd-special-tag-p) (mpc-constraints-tag-lookup): * lisp/net/ange-ftp.el (ange-ftp-send-cmd) (ange-ftp-allow-child-lookup): * lisp/net/mailcap.el (mailcap-mime-types): * lisp/net/mairix.el (mairix-search-thread-this-article): * lisp/net/pop3.el (pop3-open-server): * lisp/net/soap-client.el (soap-decode-xs-complex-type): * lisp/net/socks.el (socks-filter): * lisp/nxml/nxml-outln.el (nxml-highlighted-qname): * lisp/nxml/rng-cmpct.el (rng-c-expand-name, rng-c-expand-datatype): * lisp/nxml/rng-uri.el (rng-uri-file-name-1): * lisp/obsolete/complete.el (partial-completion-mode) (PC-do-completion): * lisp/obsolete/longlines.el (longlines-encode-string): * lisp/obsolete/nnir.el (nnir-compose-result): * lisp/obsolete/terminal.el (te-quote-arg-for-sh): * lisp/obsolete/tpu-edt.el (tpu-check-search-case): * lisp/obsolete/url-ns.el (isPlainHostName): * lisp/pcmpl-unix.el (pcomplete/scp): * lisp/play/dunnet.el (dun-listify-string2, dun-get-path) (dun-unix-parse, dun-doassign, dun-cat, dun-batch-unix-interface): * lisp/progmodes/ebnf2ps.el: (ebnf-eps-header-footer-comment): * lisp/progmodes/gdb-mi.el (gdb-var-delete) (gdb-speedbar-expand-node, gdbmi-bnf-incomplete-record-result): * lisp/progmodes/gud.el (gud-find-expr): * lisp/progmodes/idlw-help.el (idlwave-do-context-help1): * lisp/progmodes/idlw-shell.el (idlwave-shell-mode) (idlwave-shell-filter-hidden-output, idlwave-shell-filter): * lisp/progmodes/idlwave.el (idlwave-skip-label-or-case) (idlwave-routine-info): * lisp/progmodes/octave.el (inferior-octave-completion-at-point): * lisp/progmodes/sh-script.el (sh-add-completer): * lisp/progmodes/sql.el (defun): * lisp/progmodes/xscheme.el (xscheme-process-filter): * lisp/replace.el (query-replace-compile-replacement) (map-query-replace-regexp): * lisp/shell.el (shell--command-completion-data) (shell-environment-variable-completion): * lisp/simple.el (display-message-or-buffer): * lisp/speedbar.el (speedbar-dired, speedbar-tag-file) (speedbar-tag-expand): * lisp/subr.el (split-string-and-unquote): * lisp/tar-mode.el (tar-extract): * lisp/term.el (term-command-hook, serial-read-name): * lisp/textmodes/bibtex.el (bibtex-print-help-message): * lisp/textmodes/ispell.el (ispell-lookup-words, ispell-filter) (ispell-parse-output, ispell-buffer-local-parsing): * lisp/textmodes/reftex-cite.el (reftex-do-citation): * lisp/textmodes/reftex-parse.el (reftex-notice-new): * lisp/textmodes/reftex-ref.el (reftex-show-entry): * lisp/textmodes/reftex.el (reftex-compile-variables): * lisp/textmodes/tex-mode.el (tex-send-command) (tex-start-tex, tex-append): * lisp/thingatpt.el (thing-at-point-url-at-point): * lisp/tmm.el (tmm-add-one-shortcut): * lisp/transient.el (transient-format-key): * lisp/url/url-auth.el (url-basic-auth) (url-digest-auth-directory-id-assoc): * lisp/url/url-news.el (url-news): * lisp/url/url-util.el (url-parse-query-string): * lisp/vc/vc-cvs.el (vc-cvs-parse-entry): * lisp/wid-browse.el (widget-browse-sexp): * lisp/woman.el (woman-parse-colon-path, woman-mini-help) (WoMan-getpage-in-background, woman-negative-vertical-space): * lisp/xml.el: * test/lisp/emacs-lisp/check-declare-tests.el (check-declare-tests-warn): * test/lisp/files-tests.el (files-tests-file-name-non-special-dired-compress-handler): * test/lisp/net/network-stream-tests.el (server-process-filter): * test/src/coding-tests.el (ert-test-unibyte-buffer-dos-eol-decode): Use `string-search` instead of `string-match` and `string-match-p`. --- admin/authors.el | 4 ++-- lisp/apropos.el | 8 ++++---- lisp/arc-mode.el | 4 ++-- lisp/calc/calc-aent.el | 4 ++-- lisp/calc/calc-ext.el | 6 +++--- lisp/calc/calc-forms.el | 2 +- lisp/calc/calc-graph.el | 2 +- lisp/calc/calc-keypd.el | 2 +- lisp/calc/calc-lang.el | 8 ++++---- lisp/calc/calc-prog.el | 8 ++++---- lisp/calc/calc.el | 6 +++--- lisp/calc/calcalg2.el | 6 +++--- lisp/calc/calcalg3.el | 6 +++--- lisp/cedet/ede/speedbar.el | 4 ++-- lisp/cedet/semantic/java.el | 2 +- lisp/cedet/semantic/sb.el | 8 ++++---- lisp/cedet/semantic/wisent/python.el | 2 +- lisp/cus-edit.el | 2 +- lisp/descr-text.el | 2 +- lisp/dired-aux.el | 2 +- lisp/dired-x.el | 6 +++--- lisp/dired.el | 2 +- lisp/dos-fns.el | 12 ++++++------ lisp/edmacro.el | 2 +- lisp/emacs-lisp/eieio-opt.el | 4 ++-- lisp/emacs-lisp/eieio-speedbar.el | 4 ++-- lisp/emacs-lisp/lisp-mnt.el | 2 +- lisp/emacs-lisp/warnings.el | 2 +- lisp/emulation/viper-ex.el | 6 +++--- lisp/env.el | 4 ++-- lisp/epa-mail.el | 2 +- lisp/epg.el | 2 +- lisp/erc/erc-backend.el | 10 +++++----- lisp/erc/erc-dcc.el | 2 +- lisp/erc/erc-speedbar.el | 12 ++++++------ lisp/erc/erc.el | 2 +- lisp/eshell/em-glob.el | 2 +- lisp/eshell/esh-proc.el | 2 +- lisp/eshell/esh-util.el | 2 +- lisp/eshell/esh-var.el | 2 +- lisp/faces.el | 2 +- lisp/ffap.el | 2 +- lisp/files.el | 4 ++-- lisp/forms.el | 2 +- lisp/frameset.el | 2 +- lisp/gnus/gnus-art.el | 2 +- lisp/gnus/gnus-kill.el | 2 +- lisp/gnus/gnus-mlspl.el | 2 +- lisp/gnus/gnus-msg.el | 10 +++++----- lisp/gnus/gnus-rfc1843.el | 2 +- lisp/gnus/gnus-search.el | 4 ++-- lisp/gnus/gnus-spec.el | 2 +- lisp/gnus/gnus-sum.el | 2 +- lisp/gnus/gnus-util.el | 4 ++-- lisp/gnus/gnus-uu.el | 2 +- lisp/gnus/gnus.el | 8 ++++---- lisp/gnus/message.el | 26 +++++++++++++------------- lisp/gnus/mm-decode.el | 2 +- lisp/gnus/nnheader.el | 2 +- lisp/gnus/nnimap.el | 4 ++-- lisp/gnus/nnmaildir.el | 2 +- lisp/gnus/nnmairix.el | 2 +- lisp/gnus/nnrss.el | 2 +- lisp/gnus/nntp.el | 4 ++-- lisp/help-fns.el | 2 +- lisp/help.el | 2 +- lisp/hippie-exp.el | 4 ++-- lisp/htmlfontify.el | 2 +- lisp/ido.el | 10 +++++----- lisp/image/image-converter.el | 2 +- lisp/info-xref.el | 2 +- lisp/info.el | 12 ++++++------ lisp/international/mule-diag.el | 4 ++-- lisp/language/korea-util.el | 2 +- lisp/linum.el | 2 +- lisp/mail/ietf-drums.el | 2 +- lisp/mail/mail-utils.el | 2 +- lisp/mail/rfc2047.el | 4 ++-- lisp/mail/rfc2231.el | 6 +++--- lisp/mail/rmailkwd.el | 2 +- lisp/mail/rmailsum.el | 2 +- lisp/mail/smtpmail.el | 4 ++-- lisp/mail/uce.el | 8 ++++---- lisp/man.el | 2 +- lisp/mh-e/mh-alias.el | 6 +++--- lisp/mh-e/mh-comp.el | 4 ++-- lisp/mh-e/mh-speed.el | 2 +- lisp/mh-e/mh-utils.el | 4 ++-- lisp/minibuffer.el | 8 ++++---- lisp/mpc.el | 6 +++--- lisp/net/ange-ftp.el | 6 +++--- lisp/net/mailcap.el | 2 +- lisp/net/mairix.el | 2 +- lisp/net/pop3.el | 4 ++-- lisp/net/soap-client.el | 2 +- lisp/net/socks.el | 2 +- lisp/nxml/nxml-outln.el | 2 +- lisp/nxml/rng-cmpct.el | 4 ++-- lisp/nxml/rng-uri.el | 4 ++-- lisp/obsolete/complete.el | 4 ++-- lisp/obsolete/longlines.el | 4 ++-- lisp/obsolete/nnir.el | 2 +- lisp/obsolete/terminal.el | 2 +- lisp/obsolete/tpu-edt.el | 6 +++--- lisp/obsolete/url-ns.el | 2 +- lisp/pcmpl-unix.el | 2 +- lisp/play/dunnet.el | 18 +++++++++--------- lisp/progmodes/ebnf2ps.el | 2 +- lisp/progmodes/gdb-mi.el | 8 ++++---- lisp/progmodes/gud.el | 2 +- lisp/progmodes/idlw-help.el | 2 +- lisp/progmodes/idlw-shell.el | 10 +++++----- lisp/progmodes/idlwave.el | 8 ++++---- lisp/progmodes/octave.el | 2 +- lisp/progmodes/sh-script.el | 2 +- lisp/progmodes/sql.el | 2 +- lisp/progmodes/xscheme.el | 4 ++-- lisp/replace.el | 8 ++++---- lisp/shell.el | 4 ++-- lisp/simple.el | 4 ++-- lisp/speedbar.el | 12 ++++++------ lisp/subr.el | 2 +- lisp/tar-mode.el | 2 +- lisp/term.el | 6 +++--- lisp/textmodes/bibtex.el | 2 +- lisp/textmodes/ispell.el | 10 +++++----- lisp/textmodes/reftex-cite.el | 2 +- lisp/textmodes/reftex-parse.el | 2 +- lisp/textmodes/reftex-ref.el | 2 +- lisp/textmodes/reftex.el | 2 +- lisp/textmodes/tex-mode.el | 6 +++--- lisp/thingatpt.el | 2 +- lisp/tmm.el | 2 +- lisp/transient.el | 2 +- lisp/url/url-auth.el | 8 ++++---- lisp/url/url-news.el | 2 +- lisp/url/url-util.el | 2 +- lisp/vc/vc-cvs.el | 2 +- lisp/wid-browse.el | 2 +- lisp/woman.el | 10 +++++----- lisp/xml.el | 4 ++-- test/lisp/emacs-lisp/check-declare-tests.el | 10 +++++----- test/lisp/files-tests.el | 2 +- test/lisp/net/network-stream-tests.el | 2 +- test/src/coding-tests.el | 2 +- 145 files changed, 299 insertions(+), 299 deletions(-) (limited to 'lisp/progmodes/gdb-mi.el') diff --git a/admin/authors.el b/admin/authors.el index a400b1327af..b4e6c934b67 100644 --- a/admin/authors.el +++ b/admin/authors.el @@ -1330,7 +1330,7 @@ to print a message if FILE is not found." (unless (or valid (member file authors-ignored-files) (authors-obsolete-file-p file) - (string-match "[*]" file) + (string-search "*" file) (string-match "^[0-9.]+$" file) laxlog) (setq authors-invalid-file-names @@ -1465,7 +1465,7 @@ Suggested\\|Trivial\\|Version\\|Originally\\|From:\\|Patch[ \t]+[Bb]y\\)"))) ((looking-at "^[ \t]+\\*") (let ((line (buffer-substring-no-properties (match-end 0) (line-end-position)))) - (while (and (not (string-match ":" line)) + (while (and (not (string-search ":" line)) (forward-line 1) (not (looking-at ":\\|^[ \t]*$"))) (setq line (concat line diff --git a/lisp/apropos.el b/lisp/apropos.el index 376c1b2cbc5..a1470537d9a 100644 --- a/lisp/apropos.el +++ b/lisp/apropos.el @@ -616,7 +616,7 @@ while a list of strings is used as a word list." (if (eq doc 'error) "(documentation error)" (setq score (+ score (apropos-score-doc doc))) - (substring doc 0 (string-match "\n" doc))) + (substring doc 0 (string-search "\n" doc))) "(not documented)"))) (and var-predicate (funcall var-predicate symbol) @@ -625,7 +625,7 @@ while a list of strings is used as a word list." (progn (setq score (+ score (apropos-score-doc doc))) (substring doc 0 - (string-match "\n" doc))))))) + (string-search "\n" doc))))))) (setcar (cdr (car p)) score) (setq p (cdr p)))) (and (let ((apropos-multi-type do-all)) @@ -639,7 +639,7 @@ while a list of strings is used as a word list." "Like (documentation-property SYMBOL PROPERTY RAW) but handle errors." (condition-case () (let ((doc (documentation-property symbol property raw))) - (if doc (substring doc 0 (string-match "\n" doc)) + (if doc (substring doc 0 (string-search "\n" doc)) "(not documented)")) (error "(error retrieving documentation)"))) @@ -767,7 +767,7 @@ the output includes key-bindings of commands." "(alias for undefined function)") (error "(can't retrieve function documentation)"))) - (substring doc 0 (string-match "\n" doc)) + (substring doc 0 (string-search "\n" doc)) "(not documented)")) (when (boundp symbol) (apropos-documentation-property diff --git a/lisp/arc-mode.el b/lisp/arc-mode.el index 83c516100ab..71ad7bd0c5d 100644 --- a/lisp/arc-mode.el +++ b/lisp/arc-mode.el @@ -1707,7 +1707,7 @@ This doesn't recover lost files, it just undoes changes in the buffer itself." (= (get-byte p) ?\C-z) (> (get-byte (1+ p)) 0)) (let* ((namefld (buffer-substring (+ p 2) (+ p 2 13))) - (fnlen (or (string-match "\0" namefld) 13)) + (fnlen (or (string-search "\0" namefld) 13)) (efnname (decode-coding-string (substring namefld 0 fnlen) archive-file-name-coding-system)) (csize (archive-l-e (+ p 15) 4)) @@ -2089,7 +2089,7 @@ This doesn't recover lost files, it just undoes changes in the buffer itself." (dirtype (get-byte (+ p 4))) (lfnlen (if (= dirtype 2) (get-byte (+ p 56)) 0)) (ldirlen (if (= dirtype 2) (get-byte (+ p 57)) 0)) - (fnlen (or (string-match "\0" namefld) 13)) + (fnlen (or (string-search "\0" namefld) 13)) (efnname (let ((str (concat (if (> ldirlen 0) diff --git a/lisp/calc/calc-aent.el b/lisp/calc/calc-aent.el index 1e31c3cadc0..db4751a9fbb 100644 --- a/lisp/calc/calc-aent.el +++ b/lisp/calc/calc-aent.el @@ -1139,7 +1139,7 @@ If the current Calc language does not use placeholders, return nil." 0) (setq sym (intern (substring (symbol-name sym) 1)))) - (or (string-match "-" (symbol-name sym)) + (or (string-search "-" (symbol-name sym)) (setq sym (intern (concat "calcFunc-" (symbol-name sym)))))) @@ -1149,7 +1149,7 @@ If the current Calc language does not use placeholders, return nil." (let ((val (list 'var (intern (math-remove-dashes (symbol-name sym))) - (if (string-match "-" (symbol-name sym)) + (if (string-search "-" (symbol-name sym)) sym (intern (concat "var-" (symbol-name sym))))))) diff --git a/lisp/calc/calc-ext.el b/lisp/calc/calc-ext.el index e85ecf03906..45337e187be 100644 --- a/lisp/calc/calc-ext.el +++ b/lisp/calc/calc-ext.el @@ -3088,7 +3088,7 @@ If X is not an error form, return 1." (math-read-big-err-msg nil) math-read-big-baseline math-read-big-h2 new-pos p) - (while (setq new-pos (string-match "\n" str pos)) + (while (setq new-pos (string-search "\n" str pos)) (setq math-read-big-lines (cons (substring str pos new-pos) math-read-big-lines) pos (1+ new-pos))) @@ -3249,7 +3249,7 @@ If X is not an error form, return 1." (t (let ((str (math-format-flat-expr x 0)) (pos 0) p) - (or (string-match "\"" str) + (or (string-search "\"" str) (while (<= (setq p (+ pos w)) (length str)) (while (and (> (setq p (1- p)) pos) (not (= (aref str p) ? )))) @@ -3278,7 +3278,7 @@ If X is not an error form, return 1." (math-format-radix-float a prec)) (format "%d#%s" calc-number-radix (math-format-radix-float a prec))))) - (if (and prec (> prec 191) (string-match "\\*" str)) + (if (and prec (> prec 191) (string-search "*" str)) (concat "(" str ")") str)))) ((eq (car a) 'frac) diff --git a/lisp/calc/calc-forms.el b/lisp/calc/calc-forms.el index ee53b94cd64..ac57011da04 100644 --- a/lisp/calc/calc-forms.el +++ b/lisp/calc/calc-forms.el @@ -2238,7 +2238,7 @@ and ends on the last Sunday of October at 2 a.m." (if (eq (car-safe str2) 'error) str2 (append '(calcFunc-lambda) (cdr str1) (list str2))))) - (if (string-match "#" str) + (if (string-search "#" str) (let ((calc-hashes-used 0)) (and (setq str (math-read-expr str)) (if (eq (car-safe str) 'error) diff --git a/lisp/calc/calc-graph.el b/lisp/calc/calc-graph.el index 423d1e64126..9ac24bf1889 100644 --- a/lisp/calc/calc-graph.el +++ b/lisp/calc/calc-graph.el @@ -1025,7 +1025,7 @@ This \"dumb\" driver will be present in Gnuplot 3.0." (calc-pop-stack 1)))) (if (string-match "\\[.+\\]" range) (setq range (substring range 1 -1))) - (if (and (not (string-match ":" range)) + (if (and (not (string-search ":" range)) (or (string-match "," range) (string-match " " range))) (aset range (match-beginning 0) ?\:)) diff --git a/lisp/calc/calc-keypd.el b/lisp/calc/calc-keypd.el index 1902a4f3f29..acbef27a1da 100644 --- a/lisp/calc/calc-keypd.el +++ b/lisp/calc/calc-keypd.el @@ -481,7 +481,7 @@ ":" (if (and (equal cmd "e") (or (not input) - (string-match + (string-search "#" input)) (> radix 14)) (format "*%d.^" radix) diff --git a/lisp/calc/calc-lang.el b/lisp/calc/calc-lang.el index 0117f449dd5..aef3173f5c0 100644 --- a/lisp/calc/calc-lang.el +++ b/lisp/calc/calc-lang.el @@ -660,7 +660,7 @@ (setq math-exp-pos (match-end 0) math-exp-token 'punc math-expr-data "[") - (let ((right (string-match "}" math-exp-str math-exp-pos))) + (let ((right (string-search "}" math-exp-str math-exp-pos))) (and right (setq math-exp-str (copy-sequence math-exp-str)) (aset math-exp-str right ?\])))))))))) @@ -899,7 +899,7 @@ (setq math-exp-pos (match-end 0) math-exp-token 'punc math-expr-data "[") - (let ((right (string-match "}" math-exp-str math-exp-pos))) + (let ((right (string-search "}" math-exp-str math-exp-pos))) (and right (setq math-exp-str (copy-sequence math-exp-str)) (aset math-exp-str right ?\])))))))))) @@ -2342,7 +2342,7 @@ order to Calc's." (math-read-big-emptyp math-rb-h1 (1+ v) h math-rb-v2 nil t) (if (= (math-read-big-char widest v) ?\() (progn - (setq line (if (string-match "-" p) + (setq line (if (string-search "-" p) (intern p) (intern (concat "calcFunc-" p))) h (1+ widest) @@ -2362,7 +2362,7 @@ order to Calc's." (setq p (cons line (nreverse p)))) (setq p (list 'var (intern (math-remove-dashes p)) - (if (string-match "-" p) + (if (string-search "-" p) (intern p) (intern (concat "var-" p))))))) diff --git a/lisp/calc/calc-prog.el b/lisp/calc/calc-prog.el index 6f1e5c782df..f9dd9eb98a9 100644 --- a/lisp/calc/calc-prog.el +++ b/lisp/calc/calc-prog.el @@ -604,7 +604,7 @@ ((equal name "#") (search-backward "#") (error "Token `#' is reserved")) - ((and unquoted (string-match "#" name)) + ((and unquoted (string-search "#" name)) (error "Tokens containing `#' must be quoted")) ((not (string-match "[^ ]" name)) (search-backward "\"" nil t) @@ -1068,7 +1068,7 @@ Redefine the corresponding command." (insert (setq str (prin1-to-string (cons 'defun (cons cmd (cdr fcmd))))) "\n") - (or (and (string-match "\"" str) (not q-ok)) + (or (and (string-search "\"" str) (not q-ok)) (fill-region pt (point))) (indent-rigidly pt (point) 2) (delete-region pt (1+ pt)) @@ -1087,7 +1087,7 @@ Redefine the corresponding command." (cons 'defun (cons func (cdr ffunc))))) "\n") - (or (and (string-match "\"" str) (not q-ok)) + (or (and (string-search "\"" str) (not q-ok)) (fill-region pt (point))) (indent-rigidly pt (point) 2) (delete-region pt (1+ pt)) @@ -2132,7 +2132,7 @@ Redefine the corresponding command." (cdr prim)) ((memq exp math-exp-env) exp) - ((string-match "-" name) + ((string-search "-" name) exp) (t (intern (concat "var-" name)))))) diff --git a/lisp/calc/calc.el b/lisp/calc/calc.el index 1e7d5e7766c..a10b3178302 100644 --- a/lisp/calc/calc.el +++ b/lisp/calc/calc.el @@ -2126,7 +2126,7 @@ the United States." (goto-char (point-max)) (cond ((null prefix) (insert " ")) ((and (> (length prefix) 4) - (string-match " " prefix 4)) + (string-search " " prefix 4)) (insert (substring prefix 0 4) " ")) (t (insert (format "%4s " prefix)))) (insert fval "\n") @@ -2469,7 +2469,7 @@ the United States." (calc-minibuffer-contains "[-+]?\\(.*\\+/- *\\|.*mod *\\)?\\([0-9]+\\.?0*[@oh] *\\)?\\([0-9]+\\.?0*['m] *\\)?[0-9]*\\(\\.?[0-9]*\\(e[-+]?[0-3]?[0-9]?[0-9]?[0-9]?[0-9]?[0-9]?[0-9]?\\)?\\|[0-9]:\\([0-9]+:\\)?[0-9]*\\)?[\"s]?\\'")) (if (and (memq last-command-event '(?@ ?o ?h ?\' ?m)) - (string-match " " calc-hms-format)) + (string-search " " calc-hms-format)) (insert " ")) (if (and (memq last-command '(calcDigit-start calcDigit-key)) (eq last-command-event ?.)) @@ -3059,7 +3059,7 @@ the United States." (defun calc-count-lines (s) (let ((pos 0) (num 1)) - (while (setq pos (string-match "\n" s pos)) + (while (setq pos (string-search "\n" s pos)) (setq pos (1+ pos) num (1+ num))) num)) diff --git a/lisp/calc/calcalg2.el b/lisp/calc/calcalg2.el index 94b99aa29d8..8d93ae987a1 100644 --- a/lisp/calc/calcalg2.el +++ b/lisp/calc/calcalg2.el @@ -158,7 +158,7 @@ (calc-top-n 2) (calc-top-n 1))) (let ((var (if (and (string-match ",\\|[^ ] +[^ ]" var) - (not (string-match "\\[" var))) + (not (string-search "[" var))) (math-read-expr (concat "[" var "]")) (math-read-expr var)))) (if (eq (car-safe var) 'error) @@ -175,7 +175,7 @@ (calc-top-n 2) (calc-top-n 1))) (let ((var (if (and (string-match ",\\|[^ ] +[^ ]" var) - (not (string-match "\\[" var))) + (not (string-search "[" var))) (math-read-expr (concat "[" var "]")) (math-read-expr var)))) (if (eq (car-safe var) 'error) @@ -1028,7 +1028,7 @@ (fset 'calcFunc-integ math-old-integ)))) ;; See if the function is a symbolic derivative. - (and (string-match "'" (symbol-name (car expr))) + (and (string-search "'" (symbol-name (car expr))) (let ((name (symbol-name (car expr))) (p expr) (n 0) (which nil) (bad nil)) (while (setq n (1+ n) p (cdr p)) diff --git a/lisp/calc/calcalg3.el b/lisp/calc/calcalg3.el index ee3ae0a4c1f..3cb1886f3bd 100644 --- a/lisp/calc/calcalg3.el +++ b/lisp/calc/calcalg3.el @@ -56,7 +56,7 @@ (calc-top-n 1) (calc-top-n 2))) (let ((var (if (and (string-match ",\\|[^ ] +[^ ]" var) - (not (string-match "\\[" var))) + (not (string-search "[" var))) (math-read-expr (concat "[" var "]")) (math-read-expr var)))) (if (eq (car-safe var) 'error) @@ -81,7 +81,7 @@ (calc-top-n 1) (calc-top-n 2))) (let ((var (if (and (string-match ",\\|[^ ] +[^ ]" var) - (not (string-match "\\[" var))) + (not (string-search "[" var))) (math-read-expr (concat "[" var "]")) (math-read-expr var)))) (if (eq (car-safe var) 'error) @@ -490,7 +490,7 @@ defc) ","))))) (coefs nil)) - (setq vars (if (string-match "\\[" vars) + (setq vars (if (string-search "[" vars) (math-read-expr vars) (math-read-expr (concat "[" vars "]")))) (if (eq (car-safe vars) 'error) diff --git a/lisp/cedet/ede/speedbar.el b/lisp/cedet/ede/speedbar.el index 01d4f943df5..b321cb637bc 100644 --- a/lisp/cedet/ede/speedbar.el +++ b/lisp/cedet/ede/speedbar.el @@ -276,7 +276,7 @@ INDENT is the current indentation level." Etags does not support this feature. TEXT will be the button string. TOKEN will be the list, and INDENT is the current indentation level." - (cond ((string-match "\\+" text) ;we have to expand this file + (cond ((string-search "+" text) ;we have to expand this file (speedbar-change-expand-button-char ?-) (speedbar-with-writable (save-excursion @@ -284,7 +284,7 @@ level." (speedbar-insert-generic-list indent token 'ede-tag-expand 'ede-tag-find)))) - ((string-match "-" text) ;we have to contract this node + ((string-search "-" text) ;we have to contract this node (speedbar-change-expand-button-char ?+) (speedbar-delete-subblock indent)) (t (error "Ooops... not sure what to do"))) diff --git a/lisp/cedet/semantic/java.el b/lisp/cedet/semantic/java.el index f48b835fe39..0c2fb843f0b 100644 --- a/lisp/cedet/semantic/java.el +++ b/lisp/cedet/semantic/java.el @@ -141,7 +141,7 @@ corresponding compound declaration." (semantic-tag-put-attribute clone :dereference (+ dim0 (cdr dim))) (semantic-tag-set-bounds clone start end))) - ((and (eq class 'type) (string-match "\\." (semantic-tag-name tag))) + ((and (eq class 'type) (string-search "." (semantic-tag-name tag))) ;; javap outputs files where the package name is stuck onto the class or interface ;; name. To make this more regular, we extract the package name into a package statement, ;; then make the class name regular. diff --git a/lisp/cedet/semantic/sb.el b/lisp/cedet/semantic/sb.el index debdfd1dc04..fe981d34fb7 100644 --- a/lisp/cedet/semantic/sb.el +++ b/lisp/cedet/semantic/sb.el @@ -279,7 +279,7 @@ Optional MODIFIERS is additional text needed for variables." (defun semantic-sb-show-extra (text token indent) "Display additional information about the token as an expansion. TEXT TOKEN and INDENT are the details." - (cond ((string-match "\\+" text) ;we have to expand this file + (cond ((string-search "+" text) ;we have to expand this file (speedbar-change-expand-button-char ?-) (speedbar-with-writable (save-excursion @@ -288,7 +288,7 @@ TEXT TOKEN and INDENT are the details." (narrow-to-region (point) (point)) ;; Add in stuff specific to this type of token. (semantic-sb-insert-details token (1+ indent)))))) - ((string-match "-" text) ;we have to contract this node + ((string-search "-" text) ;we have to contract this node (speedbar-change-expand-button-char ?+) (speedbar-delete-subblock indent)) (t (error "Ooops... not sure what to do"))) @@ -325,7 +325,7 @@ TEXT TOKEN and INDENT are the details." (defun semantic-sb-expand-group (text token indent) "Expand a group which has semantic tokens. TEXT TOKEN and INDENT are the details." - (cond ((string-match "\\+" text) ;we have to expand this file + (cond ((string-search "+" text) ;we have to expand this file (speedbar-change-expand-button-char ?-) (speedbar-with-writable (save-excursion @@ -333,7 +333,7 @@ TEXT TOKEN and INDENT are the details." (save-restriction (narrow-to-region (point-min) (point)) (semantic-sb-buttons-plain (1+ indent) token))))) - ((string-match "-" text) ;we have to contract this node + ((string-search "-" text) ;we have to contract this node (speedbar-change-expand-button-char ?+) (speedbar-delete-subblock indent)) (t (error "Ooops... not sure what to do"))) diff --git a/lisp/cedet/semantic/wisent/python.el b/lisp/cedet/semantic/wisent/python.el index 9ac4ed9f518..fb878dde712 100644 --- a/lisp/cedet/semantic/wisent/python.el +++ b/lisp/cedet/semantic/wisent/python.el @@ -555,7 +555,7 @@ SELF or the instance name \"self\" if SELF is nil." (rx-to-string `(seq string-start ,(or self "self") ".")) name) - (not (string-match "\\." (substring name 5))))))) + (not (string-search "." (substring name 5))))))) (defun semantic-python-docstring-p (tag) "Return non-nil, when TAG is a Python documentation string." diff --git a/lisp/cus-edit.el b/lisp/cus-edit.el index 980a1cc7179..7eae2e416bb 100644 --- a/lisp/cus-edit.el +++ b/lisp/cus-edit.el @@ -1910,7 +1910,7 @@ item in another window.\n\n")) (widget-put (get 'editable-field 'widget-type) :custom-show (lambda (_widget value) (let ((pp (pp-to-string value))) - (cond ((string-match-p "\n" pp) + (cond ((string-search "\n" pp) nil) ((> (length pp) 40) nil) diff --git a/lisp/descr-text.el b/lisp/descr-text.el index 85017de5d5e..f5e467d37e7 100644 --- a/lisp/descr-text.el +++ b/lisp/descr-text.el @@ -50,7 +50,7 @@ (when (string-match-p "\n\\'" pp) (setq pp (substring pp 0 (1- (length pp))))) - (if (and (not (string-match-p "\n" pp)) + (if (and (not (string-search "\n" pp)) (<= (length pp) (- (window-width) (current-column)))) (insert pp) (insert-text-button diff --git a/lisp/dired-aux.el b/lisp/dired-aux.el index 5dbd55849e9..0b8c693b29f 100644 --- a/lisp/dired-aux.el +++ b/lisp/dired-aux.el @@ -1288,7 +1288,7 @@ Return nil if no change in files." nil t) nil t))) ;; We found an uncompression rule. - (let ((match (string-match " " command)) + (let ((match (string-search " " command)) (msg (concat "Uncompressing " file))) (unless (if match (dired-check-process msg diff --git a/lisp/dired-x.el b/lisp/dired-x.el index a990bd3fec3..380e47786fc 100644 --- a/lisp/dired-x.el +++ b/lisp/dired-x.el @@ -1044,11 +1044,11 @@ results in len2 (length file2)) ;; Find common initial file name components: (let (next) - (while (and (setq next (string-match "/" file1 index)) + (while (and (setq next (string-search "/" file1 index)) (< (setq next (1+ next)) (min len1 len2)) ;; For the comparison, both substrings must end in ;; `/', so NEXT is *one plus* the result of the - ;; string-match. + ;; string-search. ;; E.g., consider the case of linking "/tmp/a/abc" ;; to "/tmp/abc" erroneously giving "/tmp/a" instead ;; of "/tmp/" as common initial component @@ -1066,7 +1066,7 @@ results in (start 0) (count 0)) ;; Count number of slashes we must compensate for ... - (while (setq start (string-match "/" tem start)) + (while (setq start (string-search "/" tem start)) (setq count (1+ count) start (1+ start))) ;; ... and prepend a "../" for each slash found: diff --git a/lisp/dired.el b/lisp/dired.el index 816b8b69881..ff822506bf1 100644 --- a/lisp/dired.el +++ b/lisp/dired.el @@ -2909,7 +2909,7 @@ dired-buffers." (if (= (aref pattern (1+ set-start)) ?^) (+ 3 set-start) (+ 2 set-start))) - (set-end (string-match-p "]" pattern set-cont)) + (set-end (string-search "]" pattern set-cont)) (set (substring pattern set-start (1+ set-end)))) (setq regexp (concat regexp set)) (setq matched-in-pattern (1+ set-end)))) diff --git a/lisp/dos-fns.el b/lisp/dos-fns.el index 255edd0f371..e0a533c637a 100644 --- a/lisp/dos-fns.el +++ b/lisp/dos-fns.el @@ -86,7 +86,7 @@ sure to obey the 8.3 limitations." ;; close to the beginning, change that to a period. This ;; is so we could salvage more characters of the original ;; name by pushing them into the extension. - (if (and (not (string-match "\\." string)) + (if (and (not (string-search "." string)) (> (length string) 8) ;; We don't gain anything if we put the period closer ;; than 5 chars from the beginning (5 + 3 = 8). @@ -100,21 +100,21 @@ sure to obey the 8.3 limitations." ;; If we don't have a period in the first 8 chars, insert one. ;; This enables having 3 more characters from the original ;; name in the extension. - (if (> (or (string-match "\\." string) (length string)) + (if (> (or (string-search "." string) (length string)) 8) (setq string (concat (substring string 0 8) "." (substring string 8)))) - (setq firstdot (or (string-match "\\." string) + (setq firstdot (or (string-search "." string) (1- (length string)))) ;; Truncate to 3 chars after the first period. (if (> (length string) (+ firstdot 4)) (setq string (substring string 0 (+ firstdot 4)))) ;; Change all periods except the first one into underscores. ;; (DOS doesn't allow more than one period.) - (while (string-match "\\." string (1+ firstdot)) - (setq i (string-match "\\." string (1+ firstdot))) + (while (string-search "." string (1+ firstdot)) + (setq i (string-search "." string (1+ firstdot))) (aset string i ?_)) ;; If the last character of the original filename was `~' or `#', ;; make sure the munged name ends with it also. This is so that @@ -160,7 +160,7 @@ sure to obey the 8.3 limitations." (strlen (length string)) (lastchar (aref string (1- strlen))) firstdot) - (setq firstdot (string-match "\\." string)) + (setq firstdot (string-search "." string)) (cond (firstdot ;; Truncate the extension to 3 characters. diff --git a/lisp/edmacro.el b/lisp/edmacro.el index 84de69a2ce1..9e4a71c336e 100644 --- a/lisp/edmacro.el +++ b/lisp/edmacro.el @@ -559,7 +559,7 @@ doubt, use whitespace." (or fkey key) " ")))) (if prefix (setq desc (concat (edmacro-sanitize-for-string prefix) desc))) - (unless (string-match " " desc) + (unless (string-search " " desc) (let ((times 1) (pos bind-len)) (while (not (cl-mismatch rest-mac rest-mac :start1 0 :end1 bind-len diff --git a/lisp/emacs-lisp/eieio-opt.el b/lisp/emacs-lisp/eieio-opt.el index 08a6debc203..9c842f46829 100644 --- a/lisp/emacs-lisp/eieio-opt.el +++ b/lisp/emacs-lisp/eieio-opt.el @@ -323,7 +323,7 @@ current expansion depth." (defun eieio-sb-expand (text class indent) "For button TEXT, expand CLASS at the current location. Argument INDENT is the depth of indentation." - (cond ((string-match "\\+" text) ;we have to expand this file + (cond ((string-search "+" text) ;we have to expand this file (speedbar-change-expand-button-char ?-) (speedbar-with-writable (save-excursion @@ -332,7 +332,7 @@ Argument INDENT is the depth of indentation." (while subclasses (eieio-class-button (car subclasses) (1+ indent)) (setq subclasses (cdr subclasses))))))) - ((string-match "-" text) ;we have to contract this node + ((string-search "-" text) ;we have to contract this node (speedbar-change-expand-button-char ?+) (speedbar-delete-subblock indent)) (t (error "Ooops... not sure what to do"))) diff --git a/lisp/emacs-lisp/eieio-speedbar.el b/lisp/emacs-lisp/eieio-speedbar.el index 3f2a6537ab8..86b22cad73b 100644 --- a/lisp/emacs-lisp/eieio-speedbar.el +++ b/lisp/emacs-lisp/eieio-speedbar.el @@ -344,14 +344,14 @@ The object is at indentation level INDENT." (defun eieio-speedbar-object-expand (text token indent) "Expand object represented by TEXT. TOKEN is the object. INDENT is the current indentation level." - (cond ((string-match "\\+" text) ;we have to expand this file + (cond ((string-search "+" text) ;we have to expand this file (speedbar-change-expand-button-char ?-) (oset token expanded t) (speedbar-with-writable (save-excursion (end-of-line) (forward-char 1) (eieio-speedbar-expand token (1+ indent))))) - ((string-match "-" text) ;we have to contract this node + ((string-search "-" text) ;we have to contract this node (speedbar-change-expand-button-char ?+) (oset token expanded nil) (speedbar-delete-subblock indent)) diff --git a/lisp/emacs-lisp/lisp-mnt.el b/lisp/emacs-lisp/lisp-mnt.el index 83da495edf0..d6a6a5f0442 100644 --- a/lisp/emacs-lisp/lisp-mnt.el +++ b/lisp/emacs-lisp/lisp-mnt.el @@ -458,7 +458,7 @@ each line." "Return list of keywords given in file FILE." (let ((keywords (lm-keywords file))) (if keywords - (if (string-match-p "," keywords) + (if (string-search "," keywords) (split-string keywords ",[ \t\n]*" t "[ ]+") (split-string keywords "[ \t\n]+" t "[ ]+"))))) diff --git a/lisp/emacs-lisp/warnings.el b/lisp/emacs-lisp/warnings.el index 67de690e67d..36b275e2d3c 100644 --- a/lisp/emacs-lisp/warnings.el +++ b/lisp/emacs-lisp/warnings.el @@ -307,7 +307,7 @@ entirely by setting `warning-suppress-types' or 'type 'warning-suppress-log-warning 'warning-type type)) (funcall newline) - (when (and warning-fill-prefix (not (string-match "\n" message))) + (when (and warning-fill-prefix (not (string-search "\n" message))) (let ((fill-prefix warning-fill-prefix) (fill-column warning-fill-column)) (fill-region start (point)))) diff --git a/lisp/emulation/viper-ex.el b/lisp/emulation/viper-ex.el index 5b2fa048a09..55930e7e6bc 100644 --- a/lisp/emulation/viper-ex.el +++ b/lisp/emulation/viper-ex.el @@ -1100,7 +1100,7 @@ reversed." (setq viper-keep-reading-filename nil val (read-file-name (concat prompt str) nil default-directory)) (setq val (expand-file-name val)) - (if (and (string-match " " val) + (if (and (string-search " " val) (ex-cmd-accepts-multiple-files-p ex-token)) (setq val (concat "\"" val "\""))) (setq str (concat str (if (equal val "") "" " ") @@ -2300,10 +2300,10 @@ Type `mak ' (including the space) to run make with no args." (defun ex-print-display-lines (lines) (cond ;; String doesn't contain a newline. - ((not (string-match "\n" lines)) + ((not (string-search "\n" lines)) (message "%s" lines)) ;; String contains only one newline at the end. Strip it off. - ((= (string-match "\n" lines) (1- (length lines))) + ((= (string-search "\n" lines) (1- (length lines))) (message "%s" (substring lines 0 -1))) ;; String spans more than one line. Use a temporary buffer. (t diff --git a/lisp/env.el b/lisp/env.el index 51247f1ff84..83f43d1006b 100644 --- a/lisp/env.el +++ b/lisp/env.el @@ -44,7 +44,7 @@ If it is also not t, RET does not exit if it does non-null completion." (completing-read prompt (mapcar (lambda (enventry) (let ((str (substring enventry 0 - (string-match "=" enventry)))) + (string-search "=" enventry)))) (if (multibyte-string-p str) (decode-coding-string str locale-coding-system t) @@ -184,7 +184,7 @@ a side-effect." (setq variable (encode-coding-string variable locale-coding-system))) (if (and value (multibyte-string-p value)) (setq value (encode-coding-string value locale-coding-system))) - (if (string-match-p "=" variable) + (if (string-search "=" variable) (error "Environment variable name `%s' contains `='" variable)) (if (string-equal "TZ" variable) (set-time-zone-rule value)) diff --git a/lisp/epa-mail.el b/lisp/epa-mail.el index bed0c065aea..b9dd437ed12 100644 --- a/lisp/epa-mail.el +++ b/lisp/epa-mail.el @@ -219,7 +219,7 @@ If no one is selected, symmetric encryption will be performed. " (epa-mail--find-usable-key (epg-list-keys (epg-make-context epa-protocol) - (if (string-match "@" recipient) + (if (string-search "@" recipient) (concat "<" recipient ">") recipient)) 'encrypt))) diff --git a/lisp/epg.el b/lisp/epg.el index 36515ef4e5f..9d6295594fd 100644 --- a/lisp/epg.el +++ b/lisp/epg.el @@ -573,7 +573,7 @@ callback data (if any)." "--status-fd" "1" "--yes") (if (and (not (eq (epg-context-protocol context) 'CMS)) - (string-match ":" (or agent-info ""))) + (string-search ":" (or agent-info ""))) '("--use-agent")) (if (and (not (eq (epg-context-protocol context) 'CMS)) (epg-context-progress-callback context)) diff --git a/lisp/erc/erc-backend.el b/lisp/erc/erc-backend.el index 7a17ee233fd..6d84665873e 100644 --- a/lisp/erc/erc-backend.el +++ b/lisp/erc/erc-backend.el @@ -950,15 +950,15 @@ PROCs `process-buffer' is `current-buffer' when this function is called." (unless (string= string "") ;; Ignore empty strings (save-match-data (let* ((tag-list (when (eq (aref string 0) ?@) - (substring string 1 (string-match " " string)))) + (substring string 1 (string-search " " string)))) (msg (make-erc-response :unparsed string :tags (when tag-list (erc-parse-tags tag-list)))) (string (if tag-list - (substring string (+ 1 (string-match " " string))) + (substring string (+ 1 (string-search " " string))) string)) (posn (if (eq (aref string 0) ?:) - (string-match " " string) + (string-search " " string) 0))) (setf (erc-response.sender msg) @@ -968,7 +968,7 @@ PROCs `process-buffer' is `current-buffer' when this function is called." (setf (erc-response.command msg) (let* ((bposn (string-match "[^ \n]" string posn)) - (eposn (string-match " " string bposn))) + (eposn (string-search " " string bposn))) (setq posn (and eposn (string-match "[^ \n]" string eposn))) (substring string bposn eposn))) @@ -976,7 +976,7 @@ PROCs `process-buffer' is `current-buffer' when this function is called." (while (and posn (not (eq (aref string posn) ?:))) (push (let* ((bposn posn) - (eposn (string-match " " string bposn))) + (eposn (string-search " " string bposn))) (setq posn (and eposn (string-match "[^ \n]" string eposn))) (substring string bposn eposn)) diff --git a/lisp/erc/erc-dcc.el b/lisp/erc/erc-dcc.el index fcdb8df2032..de72624aaa1 100644 --- a/lisp/erc/erc-dcc.el +++ b/lisp/erc/erc-dcc.el @@ -187,7 +187,7 @@ compared with `erc-nick-equal-p' which is IRC case-insensitive." (plist-get elt prop))) ;; if the property exists and is equal, we continue, else, try the ;; next element of the list - (or (and (eq prop :nick) (string-match "!" val) + (or (and (eq prop :nick) (string-search "!" val) test (string-equal test val)) (and (eq prop :nick) test val diff --git a/lisp/erc/erc-speedbar.el b/lisp/erc/erc-speedbar.el index bb858445235..e61e741302d 100644 --- a/lisp/erc/erc-speedbar.el +++ b/lisp/erc/erc-speedbar.el @@ -139,7 +139,7 @@ This will add a speedbar major display mode." t)))) (defun erc-speedbar-expand-server (text server indent) - (cond ((string-match "\\+" text) + (cond ((string-search "+" text) (speedbar-change-expand-button-char ?-) (if (speedbar-with-writable (save-excursion @@ -147,7 +147,7 @@ This will add a speedbar major display mode." (erc-speedbar-channel-buttons nil (1+ indent) server))) (speedbar-change-expand-button-char ?-) (speedbar-change-expand-button-char ??))) - ((string-match "-" text) ;we have to contract this node + ((string-search "-" text) ;we have to contract this node (speedbar-change-expand-button-char ?+) (speedbar-delete-subblock indent)) (t (error "Ooops... not sure what to do"))) @@ -184,7 +184,7 @@ This will add a speedbar major display mode." "For the line matching TEXT, in CHANNEL, expand or contract a line. INDENT is the current indentation level." (cond - ((string-match "\\+" text) + ((string-search "+" text) (speedbar-change-expand-button-char ?-) (speedbar-with-writable (save-excursion @@ -233,7 +233,7 @@ INDENT is the current indentation level." (speedbar-with-writable (dolist (entry names) (erc-speedbar-insert-user entry ?+ (1+ indent)))))))))) - ((string-match "-" text) + ((string-search "-" text) (speedbar-change-expand-button-char ?+) (speedbar-delete-subblock indent)) (t (error "Ooops... not sure what to do"))) @@ -284,7 +284,7 @@ The update is only done when the channel is actually expanded already." (erc-speedbar-expand-channel "+" buffer 1))))) (defun erc-speedbar-expand-user (text token indent) - (cond ((string-match "\\+" text) + (cond ((string-search "+" text) (speedbar-change-expand-button-char ?-) (speedbar-with-writable (save-excursion @@ -307,7 +307,7 @@ The update is only done when the channel is actually expanded already." nil nil nil nil info nil nil nil (1+ indent))))))) - ((string-match "-" text) + ((string-search "-" text) (speedbar-change-expand-button-char ?+) (speedbar-delete-subblock indent)) (t (error "Ooops... not sure what to do"))) diff --git a/lisp/erc/erc.el b/lisp/erc/erc.el index c66b03d2e4e..73202016ba7 100644 --- a/lisp/erc/erc.el +++ b/lisp/erc/erc.el @@ -5587,7 +5587,7 @@ This returns non-nil only if we actually send anything." (when (and (erc-input-sendp state) erc-send-this) (let ((string (erc-input-string state))) - (if (or (string-match "\n" string) + (if (or (string-search "\n" string) (not (string-match erc-command-regexp string))) (mapc (lambda (line) diff --git a/lisp/eshell/em-glob.el b/lisp/eshell/em-glob.el index 316094b17e4..e36f2d0c7fe 100644 --- a/lisp/eshell/em-glob.el +++ b/lisp/eshell/em-glob.el @@ -291,7 +291,7 @@ the form: (let ((index 1)) (setq incl glob) (while (and (eq incl glob) - (setq index (string-match "~" glob index))) + (setq index (string-search "~" glob index))) (if (or (get-text-property index 'escaped glob) (or (= (1+ index) len))) (setq index (1+ index)) diff --git a/lisp/eshell/esh-proc.el b/lisp/eshell/esh-proc.el index 96c9a60deab..7a0b26a0658 100644 --- a/lisp/eshell/esh-proc.el +++ b/lisp/eshell/esh-proc.el @@ -266,7 +266,7 @@ See `eshell-needs-pipe'." ;; neither 'first nor 'last? See bug#1388 discussion. (catch 'found (dolist (exe eshell-needs-pipe) - (if (string-equal exe (if (string-match "/" exe) + (if (string-equal exe (if (string-search "/" exe) command (file-name-nondirectory command))) (throw 'found t)))))) diff --git a/lisp/eshell/esh-util.el b/lisp/eshell/esh-util.el index 30104816f07..72de6b13e2e 100644 --- a/lisp/eshell/esh-util.el +++ b/lisp/eshell/esh-util.el @@ -204,7 +204,7 @@ then quoting is done by a backslash, rather than a doubled delimiter." string (if (eq (aref string (1- len)) ?\n) (setq string (substring string 0 (1- len)))) - (if (string-match "\n" string) + (if (string-search "\n" string) (split-string string "\n") (if (and eshell-convert-numeric-arguments (string-match diff --git a/lisp/eshell/esh-var.el b/lisp/eshell/esh-var.el index 9fccc6b1c9d..5dc6a193050 100644 --- a/lisp/eshell/esh-var.el +++ b/lisp/eshell/esh-var.el @@ -381,7 +381,7 @@ This function is explicit for adding to `eshell-parse-argument-hook'." (defun eshell-envvar-names (&optional environment) "Return a list of currently visible environment variable names." (mapcar (lambda (x) - (substring x 0 (string-match "=" x))) + (substring x 0 (string-search "=" x))) (or environment process-environment))) (defun eshell-environment-variables () diff --git a/lisp/faces.el b/lisp/faces.el index 4bb3a2b00fc..a3a6f1b78dd 100644 --- a/lisp/faces.el +++ b/lisp/faces.el @@ -3062,7 +3062,7 @@ also the same size as FACE on FRAME, or fail." (let ((fonts (x-list-fonts pattern face frame 1))) (or fonts (if face - (if (string-match-p "\\*" pattern) + (if (string-search "*" pattern) (if (null (face-font face)) (error "No matching fonts are the same height as the frame default font") (error "No matching fonts are the same height as face `%s'" face)) diff --git a/lisp/ffap.el b/lisp/ffap.el index 9be9c2906ea..0069af25974 100644 --- a/lisp/ffap.el +++ b/lisp/ffap.el @@ -1418,7 +1418,7 @@ which may actually result in an URL rather than a filename." (string (ffap-string-at-point)) ; uses mode alist (name (or (condition-case nil - (and (not (string-match "//" string)) ; foo.com://bar + (and (not (string-search "//" string)) ; foo.com://bar (substitute-in-file-name string)) (error nil)) string)) diff --git a/lisp/files.el b/lisp/files.el index 54d0b919e1d..6c366177ce8 100644 --- a/lisp/files.el +++ b/lisp/files.el @@ -6979,7 +6979,7 @@ by `sh' are supported." (prog1 ; copy everything upto next `]'. (substring wildcard i - (setq j (string-match + (setq j (string-search "]" wildcard i))) (setq i (if j (1- j) (1- len))))))) ((eq ch ?.) "\\.") @@ -7105,7 +7105,7 @@ need to be passed verbatim to shell commands." ;; DOS/Windows don't allow `"' in file names. So if the ;; argument has quotes, we can safely assume it is already ;; quoted by the caller. - (if (or (string-match "[\"]" pattern) + (if (or (string-search "\"" pattern) ;; We quote [&()#$`'] in case their shell is a port of a ;; Unixy shell. We quote [,=+] because stock DOS and ;; Windows shells require that in some cases, such as diff --git a/lisp/forms.el b/lisp/forms.el index 8696aea98ee..46f4df9b6c4 100644 --- a/lisp/forms.el +++ b/lisp/forms.el @@ -1576,7 +1576,7 @@ As a side effect: sets `forms--the-record-list'." (forms--trans the-record "\n" forms-multi-line)) ;; A final sanity check before updating. - (if (string-match-p "\n" the-record) + (if (string-search "\n" the-record) (error "Multi-line fields in this record - update refused")) (with-current-buffer forms--file-buffer diff --git a/lisp/frameset.el b/lisp/frameset.el index e698d5401db..6aa94f8be5a 100644 --- a/lisp/frameset.el +++ b/lisp/frameset.el @@ -636,7 +636,7 @@ see `frameset-filter-alist'." (not (frameset-switch-to-gui-p parameters)) (let* ((prefix:p (symbol-name (car current))) (p (intern (substring prefix:p - (1+ (string-match-p ":" prefix:p))))) + (1+ (string-search ":" prefix:p))))) (val (cdr current)) (found (assq p filtered))) (if (not found) diff --git a/lisp/gnus/gnus-art.el b/lisp/gnus/gnus-art.el index d65e75e44c2..3c1403e1551 100644 --- a/lisp/gnus/gnus-art.el +++ b/lisp/gnus/gnus-art.el @@ -2519,7 +2519,7 @@ If PROMPT (the prefix), prompt for a coding system to use." format (and ctl (mail-content-type-get ctl 'format))) (when cte (setq cte (mail-header-strip-cte cte))) - (if (and ctl (not (string-match "/" (car ctl)))) + (if (and ctl (not (string-search "/" (car ctl)))) (setq ctl nil)) (goto-char (point-max))) (forward-line 1) diff --git a/lisp/gnus/gnus-kill.el b/lisp/gnus/gnus-kill.el index f73627a6480..525823e72ce 100644 --- a/lisp/gnus/gnus-kill.el +++ b/lisp/gnus/gnus-kill.el @@ -435,7 +435,7 @@ Returns the number of articles marked as read." ;; The "f:+" command marks everything *but* the matches as read, ;; so we simply first match everything as read, and then unmark ;; PATTERN later. - (when (string-match "\\+" commands) + (when (string-search "+" commands) (gnus-kill "from" ".") (setq commands "m")) diff --git a/lisp/gnus/gnus-mlspl.el b/lisp/gnus/gnus-mlspl.el index 664027f0164..6adda2ed147 100644 --- a/lisp/gnus/gnus-mlspl.el +++ b/lisp/gnus/gnus-mlspl.el @@ -169,7 +169,7 @@ Calling (gnus-group-split-fancy nil nil \"mail.others\") returns: (when (not (null params)) (let ((split-spec (assoc 'split-spec params)) group-clean) ;; Remove backend from group name - (setq group-clean (string-match ":" group)) + (setq group-clean (string-search ":" group)) (setq group-clean (if group-clean (substring group (1+ group-clean)) diff --git a/lisp/gnus/gnus-msg.el b/lisp/gnus/gnus-msg.el index db54237a767..ef89e6e9fcb 100644 --- a/lisp/gnus/gnus-msg.el +++ b/lisp/gnus/gnus-msg.el @@ -1323,7 +1323,7 @@ For the \"inline\" alternatives, also see the variable ((stringp self) (insert "Gcc: " (encode-coding-string - (if (string-match " " self) + (if (string-search " " self) (concat "\"" self "\"") self) (gnus-group-name-charset (gnus-inews-group-method self) @@ -1681,7 +1681,7 @@ this is a reply." (gnus-group-find-parameter group 'gcc-self t))) (gcc-self-get (lambda (gcc-self-val group) (if (stringp gcc-self-val) - (if (string-match " " gcc-self-val) + (if (string-search " " gcc-self-val) (concat "\"" gcc-self-val "\"") gcc-self-val) ;; In nndoc groups, we use the parent group name @@ -1689,7 +1689,7 @@ this is a reply." (let ((group (or (gnus-group-find-parameter gnus-newsgroup-name 'parent-group) group))) - (if (string-match " " group) + (if (string-search " " group) (concat "\"" group "\"") group))))) result @@ -1752,11 +1752,11 @@ this is a reply." (gnus-delete-line))) ;; Use the list of groups. (while (setq name (pop groups)) - (let ((str (if (string-match ":" name) + (let ((str (if (string-search ":" name) name (gnus-group-prefixed-name name gnus-message-archive-method)))) - (insert (if (string-match " " str) + (insert (if (string-search " " str) (concat "\"" str "\"") str))) (when groups diff --git a/lisp/gnus/gnus-rfc1843.el b/lisp/gnus/gnus-rfc1843.el index 5697c870888..c135ecea369 100644 --- a/lisp/gnus/gnus-rfc1843.el +++ b/lisp/gnus/gnus-rfc1843.el @@ -44,7 +44,7 @@ (case-fold-search t) (ct (message-fetch-field "Content-Type" t)) (ctl (and ct (mail-header-parse-content-type ct)))) - (if (and ctl (not (string-match "/" (car ctl)))) + (if (and ctl (not (string-search "/" (car ctl)))) (setq ctl nil)) (goto-char (point-max)) (widen) diff --git a/lisp/gnus/gnus-search.el b/lisp/gnus/gnus-search.el index 59b8efaa3ac..2a8069d400c 100644 --- a/lisp/gnus/gnus-search.el +++ b/lisp/gnus/gnus-search.el @@ -1392,7 +1392,7 @@ Returns a list of [group article score] vectors." (if (string-match-p "\\`[[:digit:]]+\\'" article) (string-to-number article) (nnmaildir-base-name-to-article-number - (substring article 0 (string-match ":" article)) + (substring article 0 (string-search ":" article)) group (string-remove-prefix "nnmaildir:" server)))) (when (and (numberp article) (or (null groups) @@ -2136,7 +2136,7 @@ article came from is also searched." ;; If the value contains spaces, make sure it's ;; quoted. (when (and (memql status '(exact finished)) - (or (string-match-p " " str) + (or (string-search " " str) in-string)) (unless (looking-at-p "\\s\"") (insert "\"")) diff --git a/lisp/gnus/gnus-spec.el b/lisp/gnus/gnus-spec.el index cb60108ea9c..59c6956ac2f 100644 --- a/lisp/gnus/gnus-spec.el +++ b/lisp/gnus/gnus-spec.el @@ -582,7 +582,7 @@ or to characters when given a pad value." ((string= fstring "") nil) ;; Not a format string. - ((not (string-match "%" fstring)) + ((not (string-search "%" fstring)) (list fstring)) ;; A format string with just a single string spec. ((string= fstring "%s") diff --git a/lisp/gnus/gnus-sum.el b/lisp/gnus/gnus-sum.el index dc004927b67..856e95c0ba0 100644 --- a/lisp/gnus/gnus-sum.el +++ b/lisp/gnus/gnus-sum.el @@ -9199,7 +9199,7 @@ specified by the `gnus-refer-thread-limit' variable." (unless (string-match ">$" message-id) (setq message-id (concat message-id ">"))) ;; People often post MIDs from URLs, so unhex it: - (unless (string-match "@" message-id) + (unless (string-search "@" message-id) (setq message-id (gnus-url-unhex-string message-id))) (let* ((header (gnus-id-to-header message-id)) (sparse (and header diff --git a/lisp/gnus/gnus-util.el b/lisp/gnus/gnus-util.el index 7a5e00c5ec9..70ae81d95ea 100644 --- a/lisp/gnus/gnus-util.el +++ b/lisp/gnus/gnus-util.el @@ -154,7 +154,7 @@ is slower." (and (string-match "(.+)" from) (setq name (substring from (1+ (match-beginning 0)) (1- (match-end 0))))) - (and (string-match "()" from) + (and (string-search "()" from) (setq name address)) ;; XOVER might not support folded From headers. (and (string-match "(.*" from) @@ -265,7 +265,7 @@ If END is non-nil, use the end of the span instead." (defun gnus-newsgroup-directory-form (newsgroup) "Make hierarchical directory name from NEWSGROUP name." (let* ((newsgroup (gnus-newsgroup-savable-name newsgroup)) - (idx (string-match ":" newsgroup))) + (idx (string-search ":" newsgroup))) (concat (if idx (substring newsgroup 0 idx)) (if idx "/") diff --git a/lisp/gnus/gnus-uu.el b/lisp/gnus/gnus-uu.el index ceb2ebcdcb1..6c926384c97 100644 --- a/lisp/gnus/gnus-uu.el +++ b/lisp/gnus/gnus-uu.el @@ -1434,7 +1434,7 @@ When called interactively, prompt for REGEXP." "View FILE using the gnus-uu methods." (let ((action (gnus-uu-get-action file))) (gnus-execute-command - (if (string-match "%" action) + (if (string-search "%" action) (format action file) (concat action " " file)) (eq gnus-view-pseudos 'not-confirm)))) diff --git a/lisp/gnus/gnus.el b/lisp/gnus/gnus.el index 8b93accccad..d52bd26a2cb 100644 --- a/lisp/gnus/gnus.el +++ b/lisp/gnus/gnus.el @@ -3526,7 +3526,7 @@ You should probably use `gnus-find-method-for-group' instead." (defun gnus-group-native-p (group) "Say whether the group is native or not." - (not (string-match ":" group))) + (not (string-search ":" group))) (defun gnus-group-secondary-p (group) "Say whether the group is secondary or not." @@ -3742,13 +3742,13 @@ just the host name." ;; Separate foreign select method from group name and collapse. ;; If method contains a server, collapse to non-domain server name, ;; otherwise collapse to select method. - (let* ((colon (string-match ":" group)) + (let* ((colon (string-search ":" group)) (server (and colon (substring group 0 colon))) - (plus (and server (string-match "\\+" server)))) + (plus (and server (string-search "+" server)))) (when server (if plus (setq foreign (substring server (+ 1 plus) - (string-match "\\." server)) + (string-search "." server)) group (substring group (+ 1 colon))) (setq foreign server group (substring group (+ 1 colon)))) diff --git a/lisp/gnus/message.el b/lisp/gnus/message.el index a3ffaec3ff3..bff1b2a60d9 100644 --- a/lisp/gnus/message.el +++ b/lisp/gnus/message.el @@ -5340,7 +5340,7 @@ Otherwise, generate and save a value for `canlock-password' first." (followup-to (message-fetch-field "followup-to")) to) (when (and newsgroups - (string-match "," newsgroups) + (string-search "," newsgroups) (not followup-to) (not (zerop @@ -5371,11 +5371,11 @@ Otherwise, generate and save a value for `canlock-password' first." (message-id (message-fetch-field "message-id" t))) (or (not message-id) ;; Is there an @ in the ID? - (and (string-match "@" message-id) + (and (string-search "@" message-id) ;; Is there a dot in the ID? (string-match "@[^.]*\\." message-id) ;; Does the ID end with a dot? - (not (string-match "\\.>" message-id))) + (not (string-search ".>" message-id))) (y-or-n-p (format "The Message-ID looks strange: \"%s\". Really post? " message-id))))) @@ -5497,8 +5497,8 @@ Otherwise, generate and save a value for `canlock-password' first." "@[^\\.]*\\." (setq ad (nth 1 (mail-extract-address-components from))))) ;larsi@ifi - (string-match "\\.\\." ad) ;larsi@ifi..uio - (string-match "@\\." ad) ;larsi@.ifi.uio + (string-search ".." ad) ;larsi@ifi..uio + (string-search "@." ad) ;larsi@.ifi.uio (string-match "\\.$" ad) ;larsi@ifi.uio. (not (string-match "^[^@]+@[^@]+$" ad)) ;larsi.ifi.uio (string-match "(.*).*(.*)" from)) ;(lars) (lars) @@ -5523,7 +5523,7 @@ Otherwise, generate and save a value for `canlock-password' first." (cond ((not reply-to) t) - ((string-match "," reply-to) + ((string-search "," reply-to) (y-or-n-p (format "Multiple Reply-To addresses: \"%s\". Really post? " reply-to))) @@ -5531,8 +5531,8 @@ Otherwise, generate and save a value for `canlock-password' first." "@[^\\.]*\\." (setq ad (nth 1 (mail-extract-address-components reply-to))))) ;larsi@ifi - (string-match "\\.\\." ad) ;larsi@ifi..uio - (string-match "@\\." ad) ;larsi@.ifi.uio + (string-search ".." ad) ;larsi@ifi..uio + (string-search "@." ad) ;larsi@.ifi.uio (string-match "\\.$" ad) ;larsi@ifi.uio. (not (string-match "^[^@]+@[^@]+$" ad)) ;larsi.ifi.uio (string-match "(.*).*(.*)" reply-to)) ;(lars) (lars) @@ -5806,7 +5806,7 @@ In posting styles use `(\"Expires\" (make-expires-date 30))'." (mail-header-subject message-reply-headers)) (message-strip-subject-re psubject)))) (and psupersedes - (string-match "_-_@" psupersedes))) + (string-search "_-_@" psupersedes))) "_-_" "")) "@" (message-make-fqdn) ">")) @@ -6022,7 +6022,7 @@ give as trustworthy answer as possible." "Return the pertinent part of `user-mail-address'." (when (and user-mail-address (string-match "@.*\\." user-mail-address)) - (if (string-match " " user-mail-address) + (if (string-search " " user-mail-address) (nth 1 (mail-extract-address-components user-mail-address)) user-mail-address))) @@ -6053,7 +6053,7 @@ give as trustworthy answer as possible." message-user-fqdn) ;; A system name without any dots is unlikely to be a good fully ;; qualified domain name. - ((and (string-match "[.]" sysname) + ((and (string-search "." sysname) (not (string-match message-bogus-system-names sysname))) ;; `system-name' returned the right result. sysname) @@ -7053,7 +7053,7 @@ article, it has the value of " mft " -which directs your response to " (if (string-match "," mft) +which directs your response to " (if (string-search "," mft) "the specified addresses" "that address only") ". @@ -7357,7 +7357,7 @@ want to get rid of this query permanently.")) You should normally obey the Followup-To: header. `Followup-To: " followup-to "' -directs your response to " (if (string-match "," followup-to) +directs your response to " (if (string-search "," followup-to) "the specified newsgroups" "that newsgroup only") ". diff --git a/lisp/gnus/mm-decode.el b/lisp/gnus/mm-decode.el index 02cd6af0c98..82d1de25f3d 100644 --- a/lisp/gnus/mm-decode.el +++ b/lisp/gnus/mm-decode.el @@ -649,7 +649,7 @@ MIME-Version header before proceeding." (setq description (mail-decode-encoded-word-string description))))) (if (or (not ctl) - (not (string-match "/" (car ctl)))) + (not (string-search "/" (car ctl)))) (mm-dissect-singlepart (list mm-dissect-default-type) (and cte (intern (downcase (mail-header-strip-cte cte)))) diff --git a/lisp/gnus/nnheader.el b/lisp/gnus/nnheader.el index 708887cb9c7..c35e89289a2 100644 --- a/lisp/gnus/nnheader.el +++ b/lisp/gnus/nnheader.el @@ -803,7 +803,7 @@ If FORMAT isn't a format string, it and all ARGS will be inserted without formatting." (with-current-buffer nntp-server-buffer (erase-buffer) - (if (string-match "%" format) + (if (string-search "%" format) (insert (apply #'format format args)) (apply #'insert format args)) t)) diff --git a/lisp/gnus/nnimap.el b/lisp/gnus/nnimap.el index 3cf65453f3b..8a48cd87dba 100644 --- a/lisp/gnus/nnimap.el +++ b/lisp/gnus/nnimap.el @@ -1299,7 +1299,7 @@ If LIMIT, first try to limit the search to the N last articles." (when (and (nnimap-greeting nnimap-object) (string-match greeting-match (nnimap-greeting nnimap-object)) (eq type 'append) - (string-match "\000" data)) + (string-search "\000" data)) (let ((choice (gnus-multiple-choice "Message contains NUL characters. Delete, continue, abort? " '((?d "Delete NUL characters") @@ -1761,7 +1761,7 @@ If LIMIT, first try to limit the search to the N last articles." (let ((result nil)) (dolist (elem (split-string irange ",")) (push - (if (string-match ":" elem) + (if (string-search ":" elem) (let ((numbers (split-string elem ":"))) (cons (string-to-number (car numbers)) (string-to-number (cadr numbers)))) diff --git a/lisp/gnus/nnmaildir.el b/lisp/gnus/nnmaildir.el index 372df64e2e5..171f0813b38 100644 --- a/lisp/gnus/nnmaildir.el +++ b/lisp/gnus/nnmaildir.el @@ -87,7 +87,7 @@ See `nnmaildir-flag-mark-mapping'." (defun nnmaildir--ensure-suffix (filename) "Ensure that FILENAME contains the suffix \":2,\"." - (if (string-match-p ":2," filename) + (if (string-search ":2," filename) filename (concat filename ":2,"))) diff --git a/lisp/gnus/nnmairix.el b/lisp/gnus/nnmairix.el index c6aaf460ece..92944887f44 100644 --- a/lisp/gnus/nnmairix.el +++ b/lisp/gnus/nnmairix.el @@ -1629,7 +1629,7 @@ SERVER." (while (string-match "[<>]" mid) (setq mid (replace-match "" t t mid))) ;; mairix somehow does not like '$' in message-id - (when (string-match "\\$" mid) + (when (string-search "$" mid) (setq mid (concat mid "="))) (while (string-match "\\$" mid) (setq mid (replace-match "=," t t mid))) diff --git a/lisp/gnus/nnrss.el b/lisp/gnus/nnrss.el index 8cd8cbe84f1..0f12ee0e9d2 100644 --- a/lisp/gnus/nnrss.el +++ b/lisp/gnus/nnrss.el @@ -849,7 +849,7 @@ DATA should be the output of `xml-parse-region'." (defmacro nnrss-match-macro (base-uri item onsite-list offsite-list) `(cond ((or (string-match (concat "^" ,base-uri) ,item) - (not (string-match "://" ,item))) + (not (string-search "://" ,item))) (setq ,onsite-list (append ,onsite-list (list ,item)))) (t (setq ,offsite-list (append ,offsite-list (list ,item)))))) diff --git a/lisp/gnus/nntp.el b/lisp/gnus/nntp.el index 1fd2ed06eba..615a3c931bf 100644 --- a/lisp/gnus/nntp.el +++ b/lisp/gnus/nntp.el @@ -1697,7 +1697,7 @@ If SEND-IF-FORCE, only send authinfo to the server if the ;; article comes from that group, I'd say. ((and (setq newsgroups (mail-fetch-field "newsgroups")) - (not (string-match "," newsgroups))) + (not (string-search "," newsgroups))) newsgroups) ;; If there is more than one group in the ;; Newsgroups header, then the Xref header should @@ -1725,7 +1725,7 @@ If SEND-IF-FORCE, only send authinfo to the server if the number (string-to-number (match-string 2 xref)))) ((and (setq newsgroups (mail-fetch-field "newsgroups")) - (not (string-match "," newsgroups))) + (not (string-search "," newsgroups))) (setq group newsgroups)) (group) (t (setq group "")))) diff --git a/lisp/help-fns.el b/lisp/help-fns.el index d7fb038f45a..2c7956d9680 100644 --- a/lisp/help-fns.el +++ b/lisp/help-fns.el @@ -154,7 +154,7 @@ with the current prefix. The files are chosen according to (mapcar (lambda (c) (let* ((s (intern c)) (doc (condition-case nil (documentation s) (error nil))) - (doc (and doc (substring doc 0 (string-match "\n" doc))))) + (doc (and doc (substring doc 0 (string-search "\n" doc))))) (list c (propertize (format "%-4s" (help--symbol-class s)) 'face 'completions-annotations) diff --git a/lisp/help.el b/lisp/help.el index ba27fc5810f..29ae3404813 100644 --- a/lisp/help.el +++ b/lisp/help.el @@ -1912,7 +1912,7 @@ the same names as used in the original source code, when possible." (let ((name (symbol-name arg))) (if (eq (aref name 0) ?&) (memq arg '(&rest &optional)) - (not (string-match "\\." name))))) + (not (string-search "." name))))) (setq valid nil))) (when valid arglist))) (let* ((arity (func-arity def)) diff --git a/lisp/hippie-exp.el b/lisp/hippie-exp.el index cbb69b206d4..4fadbbe4180 100644 --- a/lisp/hippie-exp.el +++ b/lisp/hippie-exp.el @@ -507,8 +507,8 @@ otherwise." "Try to slam together two parts of a file specification, system dependently." (cond ((null dir-part) name-part) ((eq system-type 'ms-dos) - (if (and (string-match "\\\\" dir-part) - (not (string-match "/" dir-part)) + (if (and (string-search "\\" dir-part) + (not (string-search "/" dir-part)) (= (aref name-part (1- (length name-part))) ?/)) (aset name-part (1- (length name-part)) ?\\)) (concat dir-part name-part)) diff --git a/lisp/htmlfontify.el b/lisp/htmlfontify.el index b453061388f..3b961989e3e 100644 --- a/lisp/htmlfontify.el +++ b/lisp/htmlfontify.el @@ -1902,7 +1902,7 @@ tree depth, as determined from FILE (a filename). START is the offset at which to start looking for the / character in FILE." ;;(message "hfy-relstub");;DBUG (let ((c "")) - (while (setq start (string-match "/" file start)) + (while (setq start (string-search "/" file start)) (setq start (1+ start)) (setq c (concat c "../"))) c)) diff --git a/lisp/ido.el b/lisp/ido.el index ea5ff32b8d7..b81a9db5eb9 100644 --- a/lisp/ido.el +++ b/lisp/ido.el @@ -1770,7 +1770,7 @@ is enabled then some keybindings are changed in the keymap." (let ((l (length dirname))) (if (and max-width (> max-width 0) (> l max-width)) (let* ((s (substring dirname (- max-width))) - (i (string-match "/" s))) + (i (string-search "/" s))) (concat "..." (if i (substring s i) s))) dirname))))) (t prompt))) @@ -2516,7 +2516,7 @@ If cursor is not at the end of the user input, move to end of input." ;; Do nothing ) ((and (memq ido-cur-item '(file dir)) - (string-match "[$]" ido-text)) + (string-search "$" ido-text)) (let ((evar (substitute-in-file-name (concat ido-current-directory ido-text)))) (if (not (file-exists-p (file-name-directory evar))) (message "Expansion generates non-existing directory name") @@ -3089,7 +3089,7 @@ If repeated, insert text from buffer instead." (setq ido-text-init word ido-try-merged-list nil ido-exit 'chdir)) - ((string-match "/" word) + ((string-search "/" word) (setq ido-text-init (concat ido-current-directory word) ido-try-merged-list nil ido-exit 'chdir)) @@ -4559,7 +4559,7 @@ For details of keybindings, see `ido-find-file'." (setq try-single-dir-match t)))) ((and (string-equal (substring contents -2 -1) "/") - (not (string-match "[$]" contents))) + (not (string-search "$" contents))) (ido-set-current-directory (cond ((= (length contents) 2) @@ -4656,7 +4656,7 @@ For details of keybindings, see `ido-find-file'." (memq ido-cur-item '(file dir)) (not (ido-is-root-directory)) (> (length contents) 1) - (not (string-match "[$]" contents)) + (not (string-search "$" contents)) (not ido-directory-nonreadable) (not ido-directory-too-big)) (ido-trace "merge?") diff --git a/lisp/image/image-converter.el b/lisp/image/image-converter.el index 97bf1ac058c..75d2e6692c0 100644 --- a/lisp/image/image-converter.el +++ b/lisp/image/image-converter.el @@ -78,7 +78,7 @@ is a string, it should be a MIME format string like (string-match image-converter-regexp source)) (and data-p (symbolp data-p) - (string-match "/" (symbol-name data-p)) + (string-search "/" (symbol-name data-p)) (string-match image-converter-regexp (concat "foo." (image-converter--mime-type data-p))))) diff --git a/lisp/info-xref.el b/lisp/info-xref.el index 538a017f3c0..e2e3e30ca21 100644 --- a/lisp/info-xref.el +++ b/lisp/info-xref.el @@ -547,7 +547,7 @@ the sources handy." ;; skip nodes with "%" as probably `format' strings such as in ;; info-look.el - (unless (string-match "%" node) + (unless (string-search "%" node) ;; "(emacs)" is the default manual for docstring hyperlinks, ;; per `help-make-xrefs' diff --git a/lisp/info.el b/lisp/info.el index 1c477a7082f..3718a1eb83f 100644 --- a/lisp/info.el +++ b/lisp/info.el @@ -2483,7 +2483,7 @@ Table of contents is created from the tree structure of menus." (match-string-no-properties 1))) (section "Top") menu-items) - (when (and upnode (string-match "(" upnode)) (setq upnode nil)) + (when (and upnode (string-search "(" upnode)) (setq upnode nil)) (when (and (not (Info-index-node nodename file)) (re-search-forward "^\\* Menu:" bound t)) (forward-line 1) @@ -2616,7 +2616,7 @@ new buffer." (let (target i (str (concat "\\*note " (regexp-quote footnotename))) (case-fold-search t)) - (while (setq i (string-match " " str i)) + (while (setq i (string-search " " str i)) (setq str (concat (substring str 0 i) "[ \t\n]+" (substring str (1+ i)))) (setq i (+ i 6))) (save-excursion @@ -2933,7 +2933,7 @@ last sub-node, if any; otherwise go \"up\" to the parent node." (let ((prevnode (Info-extract-pointer "prev[ious]*" t)) (upnode (Info-extract-pointer "up" t)) (case-fold-search t)) - (cond ((and upnode (string-match "(" upnode)) + (cond ((and upnode (string-search "(" upnode)) (user-error "First node in file")) ((and upnode (or (null prevnode) ;; Use string-equal, not equal, @@ -3778,7 +3778,7 @@ Build a menu of the possible matches." "The following packages match the keyword ‘" nodename "’:\n\n") (insert "* Menu:\n\n") (let ((keywords - (mapcar #'intern (if (string-match-p "," nodename) + (mapcar #'intern (if (string-search "," nodename) (split-string nodename ",[ \t\n]*" t) (list nodename)))) hits desc) @@ -5244,7 +5244,7 @@ The INDENT level is ignored." TEXT is the text of the button we clicked on, a + or - item. TOKEN is data related to this node (NAME . FILE). INDENT is the current indentation depth." - (cond ((string-match "\\+" text) ;we have to expand this file + (cond ((string-search "+" text) ;we have to expand this file (speedbar-change-expand-button-char ?-) (if (speedbar-with-writable (save-excursion @@ -5252,7 +5252,7 @@ INDENT is the current indentation depth." (Info-speedbar-hierarchy-buttons nil (1+ indent) token))) (speedbar-change-expand-button-char ?-) (speedbar-change-expand-button-char ??))) - ((string-match "-" text) ;we have to contract this node + ((string-search "-" text) ;we have to contract this node (speedbar-change-expand-button-char ?+) (speedbar-delete-subblock indent)) (t (error "Ooops... not sure what to do"))) diff --git a/lisp/international/mule-diag.el b/lisp/international/mule-diag.el index 2d3cd25b4a4..02169ceb689 100644 --- a/lisp/international/mule-diag.el +++ b/lisp/international/mule-diag.el @@ -905,13 +905,13 @@ The IGNORED argument is ignored." (setq family "*-*") (if (symbolp family) (setq family (symbol-name family))) - (or (string-match "-" family) + (or (string-search "-" family) (setq family (concat "*-" family)))) (if (not registry) (setq registry "*-*") (if (symbolp registry) (setq registry (symbol-name registry))) - (or (string-match "-" registry) + (or (string-search "-" registry) (= (aref registry (1- (length registry))) ?*) (setq registry (concat registry "*")))) (insert (format"\n -%s-%s-%s-%s-%s-*-*-*-*-*-*-%s" diff --git a/lisp/language/korea-util.el b/lisp/language/korea-util.el index b999eff662f..121a4c542e7 100644 --- a/lisp/language/korea-util.el +++ b/lisp/language/korea-util.el @@ -29,7 +29,7 @@ ;;;###autoload (defvar default-korean-keyboard - (purecopy (if (string-match "3" (or (getenv "HANGUL_KEYBOARD_TYPE") "")) + (purecopy (if (string-search "3" (or (getenv "HANGUL_KEYBOARD_TYPE") "")) "3" "")) "The kind of Korean keyboard for Korean (Hangul) input method. diff --git a/lisp/linum.el b/lisp/linum.el index b0281d366cd..c78f596d768 100644 --- a/lisp/linum.el +++ b/lisp/linum.el @@ -219,7 +219,7 @@ Linum mode is a buffer-local minor mode." ;; update overlays on deletions, and after newlines are inserted (when (or (= beg end) (= end (point-max)) - (string-match-p "\n" (buffer-substring-no-properties beg end))) + (string-search "\n" (buffer-substring-no-properties beg end))) (linum-update-current))) (defun linum-after-scroll (win _start) diff --git a/lisp/mail/ietf-drums.el b/lisp/mail/ietf-drums.el index 2d683574743..b1682cf78a2 100644 --- a/lisp/mail/ietf-drums.el +++ b/lisp/mail/ietf-drums.el @@ -236,7 +236,7 @@ If DECODE, the DISPLAY-NAME will have RFC2047 decoding performed (setq display-string (ietf-drums-get-comment string))) (if (not mailbox) (when (and display-string - (string-match "@" display-string)) + (string-search "@" display-string)) (cons (mapconcat #'identity (nreverse display-name) "") (ietf-drums-get-comment string))) diff --git a/lisp/mail/mail-utils.el b/lisp/mail/mail-utils.el index bb1f8f13bac..3eb3ccb93de 100644 --- a/lisp/mail/mail-utils.el +++ b/lisp/mail/mail-utils.el @@ -252,7 +252,7 @@ comma-separated list, and return the pruned list." (setq cur-pos (string-match "[,\"]" destinations cur-pos)) (if (and cur-pos (equal (match-string 0 destinations) "\"")) ;; Search for matching quote. - (let ((next-pos (string-match "\"" destinations (1+ cur-pos)))) + (let ((next-pos (string-search "\"" destinations (1+ cur-pos)))) (if next-pos (setq cur-pos (1+ next-pos)) ;; If the open-quote has no close-quote, diff --git a/lisp/mail/rfc2047.el b/lisp/mail/rfc2047.el index 5b08713949f..c442913d282 100644 --- a/lisp/mail/rfc2047.el +++ b/lisp/mail/rfc2047.el @@ -612,7 +612,7 @@ should not change this value.") (setq next prev prev nil) (if (or (< index limit) - (<= (+ len (or (string-match "\n" tail) + (<= (+ len (or (string-search "\n" tail) (length tail))) rfc2047-encode-max-chars)) (setq prev next @@ -1111,7 +1111,7 @@ strings are stripped." "Decode MIME-encoded STRING and return the result. If ADDRESS-MIME is non-nil, strip backslashes which precede characters other than `\"' and `\\' in quoted strings." - (if (string-match "=\\?" string) + (if (string-search "=?" string) (with-temp-buffer ;; We used to only call mm-enable-multibyte if `m' is non-nil, ;; but this can't be the right criterion. Don't just revert this diff --git a/lisp/mail/rfc2231.el b/lisp/mail/rfc2231.el index db34fd2cb9e..a398ce0e9cc 100644 --- a/lisp/mail/rfc2231.el +++ b/lisp/mail/rfc2231.el @@ -61,12 +61,12 @@ must never cause a Lisp error." ;; make it parsable. Let's try... (error (let (mod) - (when (and (string-match "\\\\\"" string) + (when (and (string-search "\\\"" string) (not (string-match "\\`\"\\|[^\\]\"" string))) (setq string (string-replace "\\\"" "\"" string) mod t)) - (when (and (string-match "\\\\(" string) - (string-match "\\\\)" string) + (when (and (string-search "\\(" string) + (string-search "\\)" string) (not (string-match "\\`(\\|[^\\][()]" string))) (setq string (replace-regexp-in-string "\\\\\\([()]\\)" "\\1" string) diff --git a/lisp/mail/rmailkwd.el b/lisp/mail/rmailkwd.el index acbb5880b5c..58a8eb7a370 100644 --- a/lisp/mail/rmailkwd.el +++ b/lisp/mail/rmailkwd.el @@ -93,7 +93,7 @@ according to the choice made, and returns a symbol." "Set LABEL as present or absent according to STATE in message MSG. LABEL may be a symbol or string." (or (stringp label) (setq label (symbol-name label))) - (if (string-match "," label) + (if (string-search "," label) (error "More than one label specified")) (with-current-buffer rmail-buffer (rmail-maybe-set-message-counters) diff --git a/lisp/mail/rmailsum.el b/lisp/mail/rmailsum.el index ac933b9706d..9dd9573a9fc 100644 --- a/lisp/mail/rmailsum.el +++ b/lisp/mail/rmailsum.el @@ -759,7 +759,7 @@ the message being processed." ;; If there are multiple lines in FROM, ;; discard up to the last newline in it. (while (and (stringp from) - (setq newline (string-match "\n" from))) + (setq newline (string-search "\n" from))) (setq from (substring from (1+ newline)))) (if (or (null from) (string-match diff --git a/lisp/mail/smtpmail.el b/lisp/mail/smtpmail.el index 8e3927cdcf2..ec9f340db86 100644 --- a/lisp/mail/smtpmail.el +++ b/lisp/mail/smtpmail.el @@ -516,7 +516,7 @@ for `smtpmail-try-auth-method'.") (defun smtpmail-maybe-append-domain (recipient) (if (or (not smtpmail-sendto-domain) - (string-match "@" recipient)) + (string-search "@" recipient)) recipient (concat recipient "@" smtpmail-sendto-domain))) @@ -700,7 +700,7 @@ Returns an error if the server cannot be contacted." (let ((parts (split-string user-mail-address "@"))) (and (= (length parts) 2) ;; There's a dot in the domain name. - (string-match "\\." (cadr parts)) + (string-search "." (cadr parts)) user-mail-address)))) (defun smtpmail-via-smtp (recipient smtpmail-text-buffer diff --git a/lisp/mail/uce.el b/lisp/mail/uce.el index 9ebffef2e59..b07004de38c 100644 --- a/lisp/mail/uce.el +++ b/lisp/mail/uce.el @@ -246,10 +246,10 @@ You might need to set `uce-mail-reader' before using this." (if reply-to (setq to (format "%s, %s" to (mail-strip-quoted-names reply-to)))) (let (first-at-sign end-of-hostname sender-host) - (setq first-at-sign (string-match "@" to) + (setq first-at-sign (string-search "@" to) end-of-hostname (string-match "[ ,>]" to first-at-sign) sender-host (substring to first-at-sign end-of-hostname)) - (if (string-match "\\." sender-host) + (if (string-search "." sender-host) (setq to (format "%s, postmaster%s, abuse%s" to sender-host sender-host)))) (setq mail-send-actions nil) @@ -291,7 +291,7 @@ You might need to set `uce-mail-reader' before using this." (search-forward " ") (forward-char -1) ;; And add its postmaster to the list of addresses. - (if (string-match "\\." (buffer-substring temp (point))) + (if (string-search "." (buffer-substring temp (point))) (setq to (format "%s, postmaster@%s" to (buffer-substring temp (point))))) ;; Also look at the message-id, it helps *very* often. @@ -302,7 +302,7 @@ You might need to set `uce-mail-reader' before using this." (setq temp (point)) (search-forward ">") (forward-char -1) - (if (string-match "\\." (buffer-substring temp (point))) + (if (string-search "." (buffer-substring temp (point))) (setq to (format "%s, postmaster@%s" to (buffer-substring temp (point))))))) (when (eq uce-mail-reader 'gnus) diff --git a/lisp/man.el b/lisp/man.el index 54b6ffe9836..6009a319198 100644 --- a/lisp/man.el +++ b/lisp/man.el @@ -801,7 +801,7 @@ POS defaults to `point'." ;; doesn't include a hyphen, we consider the hyphen to be ;; added by troff, and remove it. (or (not (eq (string-to-char (substring 1st-part -1)) ?-)) - (string-match-p "-" (substring 1st-part 0 -1)) + (string-search "-" (substring 1st-part 0 -1)) (setq word (string-replace "-" "" word)))) ;; Make sure the section number gets included by the code below. (goto-char (match-end 1))) diff --git a/lisp/mh-e/mh-alias.el b/lisp/mh-e/mh-alias.el index 415e9848258..37fdb166011 100644 --- a/lisp/mh-e/mh-alias.el +++ b/lisp/mh-e/mh-alias.el @@ -111,10 +111,10 @@ COMMA-SEPARATOR is non-nil." (string-match "^\\([^,]+\\)," res)) (setq res (match-string 1 res))) ;; Replace "&" with capitalized username - (if (string-match "&" res) + (if (string-search "&" res) (setq res (mh-replace-regexp-in-string "&" (capitalize username) res))) ;; Remove " character - (if (string-match "\"" res) + (if (string-search "\"" res) (setq res (mh-replace-regexp-in-string "\"" "" res))) ;; If empty string, use username instead (if (string-equal "" res) @@ -285,7 +285,7 @@ Blind aliases or users from /etc/passwd are not expanded." (message "%s -> %s" the-name (mh-alias-expand the-name)) ;; Check if it was a single word likely to be an alias (if (and (equal mh-alias-flash-on-comma 1) - (not (string-match " " the-name))) + (not (string-search " " the-name))) (message "No alias for %s" the-name)))))) (self-insert-command 1)) diff --git a/lisp/mh-e/mh-comp.el b/lisp/mh-e/mh-comp.el index b64bbfb6f3b..4fae69defaf 100644 --- a/lisp/mh-e/mh-comp.el +++ b/lisp/mh-e/mh-comp.el @@ -637,8 +637,8 @@ See also `mh-compose-forward-as-mime-flag', (defun mh-forwarded-letter-subject (from subject) "Return a Subject suitable for a forwarded message. Original message has headers FROM and SUBJECT." - (let ((addr-start (string-match "<" from)) - (comment (string-match "(" from))) + (let ((addr-start (string-search "<" from)) + (comment (string-search "(" from))) (cond ((and addr-start (> addr-start 0)) ;; Full Name (setq from (substring from 0 (1- addr-start)))) diff --git a/lisp/mh-e/mh-speed.el b/lisp/mh-e/mh-speed.el index 3af840c3a31..76ef990d825 100644 --- a/lisp/mh-e/mh-speed.el +++ b/lisp/mh-e/mh-speed.el @@ -441,7 +441,7 @@ be handled next." (position 0) line-end line folder unseen total) (unwind-protect - (while (setq line-end (string-match "\n" output position)) + (while (setq line-end (string-search "\n" output position)) (setq line (format "%s%s" mh-speed-partial-line (substring output position line-end)) diff --git a/lisp/mh-e/mh-utils.el b/lisp/mh-e/mh-utils.el index 8e900dc0113..bbce17013b1 100644 --- a/lisp/mh-e/mh-utils.el +++ b/lisp/mh-e/mh-utils.el @@ -378,7 +378,7 @@ names and the function is called when OUTPUT is available." (prevailing-match-data (match-data)) line-end folder) (unwind-protect - (while (setq line-end (string-match "\n" output position)) + (while (setq line-end (string-search "\n" output position)) (setq folder (format "+%s%s" mh-flists-partial-line (substring output position line-end))) @@ -702,7 +702,7 @@ See Info node `(elisp) Programmed Completion' for details." (let ((slash (mh-search-from-end ?/ orig-name))) (if slash (1+ slash) (if (string-match "\\`\\+" orig-name) 1 0))) - (if (cdr flag) (string-match "/" (cdr flag))))) + (if (cdr flag) (string-search "/" (cdr flag))))) ((eq flag nil) (let ((try-res (try-completion diff --git a/lisp/minibuffer.el b/lisp/minibuffer.el index 2c6340e1c3e..9f327df28f5 100644 --- a/lisp/minibuffer.el +++ b/lisp/minibuffer.el @@ -2741,7 +2741,7 @@ Useful to give the user default values that won't be substituted." (defun completion--make-envvar-table () (mapcar (lambda (enventry) - (substring enventry 0 (string-match-p "=" enventry))) + (substring enventry 0 (string-search "=" enventry))) process-environment)) (defconst completion--embedded-envvar-re @@ -2810,7 +2810,7 @@ same as `substitute-in-file-name'." pred action)) ((eq (car-safe action) 'boundaries) (let ((start (length (file-name-directory string))) - (end (string-match-p "/" (cdr action)))) + (end (string-search "/" (cdr action)))) `(boundaries ;; if `string' is "C:" in w32, (file-name-directory string) ;; returns "C:/", so `start' is 3 rather than 2. @@ -3988,7 +3988,7 @@ which is at the core of flex logic. The extra (defun completion-flex-try-completion (string table pred point) "Try to flex-complete STRING in TABLE given PRED and POINT." - (unless (and completion-flex-nospace (string-match-p " " string)) + (unless (and completion-flex-nospace (string-search " " string)) (pcase-let ((`(,all ,pattern ,prefix ,suffix ,_carbounds) (completion-substring--all-completions string table pred point @@ -4005,7 +4005,7 @@ which is at the core of flex logic. The extra (defun completion-flex-all-completions (string table pred point) "Get flex-completions of STRING in TABLE, given PRED and POINT." - (unless (and completion-flex-nospace (string-match-p " " string)) + (unless (and completion-flex-nospace (string-search " " string)) (pcase-let ((`(,all ,pattern ,prefix ,_suffix ,_carbounds) (completion-substring--all-completions string table pred point diff --git a/lisp/mpc.el b/lisp/mpc.el index e04ffa49747..029f0ca8f42 100644 --- a/lisp/mpc.el +++ b/lisp/mpc.el @@ -305,7 +305,7 @@ defaults to 6600 and HOST defaults to localhost." (defun mpc--proc-quote-string (s) (if (numberp s) (number-to-string s) (setq s (replace-regexp-in-string "[\"\\]" "\\\\\\&" s)) - (if (string-match " " s) (concat "\"" s "\"") s))) + (if (string-search " " s) (concat "\"" s "\"") s))) (defconst mpc--proc-alist-to-alists-starters '(file directory)) @@ -611,7 +611,7 @@ Any call to `mpc-status-refresh' may cause it to be restarted." (defun mpc-cmd-special-tag-p (tag) (or (memq tag '(Playlist Search Directory)) - (string-match "|" (symbol-name tag)))) + (string-search "|" (symbol-name tag)))) (defun mpc-cmd-find (tag value) "Return a list of all songs whose tag TAG has value VALUE. @@ -1438,7 +1438,7 @@ when constructing the set of constraints." (let (res) (dolist (constraint constraints) (when (or (eq (car constraint) buffer-tag) - (and (string-match "|" (symbol-name buffer-tag)) + (and (string-search "|" (symbol-name buffer-tag)) (member (symbol-name (car constraint)) (split-string (symbol-name buffer-tag) "|")))) (setq res (cdr constraint)))) diff --git a/lisp/net/ange-ftp.el b/lisp/net/ange-ftp.el index 3f3a3df8e55..e302aa89f30 100644 --- a/lisp/net/ange-ftp.el +++ b/lisp/net/ange-ftp.el @@ -2296,7 +2296,7 @@ and NOWAIT." ;; If the dir name contains a space, some ftp servers will ;; refuse to list it. We instead change directory to the ;; directory in question and ls ".". - (when (string-match " " cmd1) + (when (string-search " " cmd1) ;; Keep the result. In case of failure, we will (see below) ;; short-circuit CMD and return this result directly. (setq result (ange-ftp-cd host user (nth 1 cmd) 'noerror)) @@ -2881,13 +2881,13 @@ NO-ERROR, if a listing for DIRECTORY cannot be obtained." (or ;; No dots in dir names in vms. (and (eq host-type 'vms) - (string-match "\\." efile)) + (string-search "." efile)) ;; No subdirs in mts of cms. (and (memq host-type '(mts cms)) (not (string-equal "/" (nth 2 parsed)))) ;; No dots in pseudo-dir names in bs2000. (and (eq host-type 'bs2000) - (string-match "\\." efile)))))) + (string-search "." efile)))))) (defun ange-ftp-file-entry-p (name) "Given NAME, return whether there is a file entry for it." diff --git a/lisp/net/mailcap.el b/lisp/net/mailcap.el index aeeb9bd8d3b..5473ba7e697 100644 --- a/lisp/net/mailcap.el +++ b/lisp/net/mailcap.el @@ -1075,7 +1075,7 @@ For instance, \"foo.png\" will result in \"image/png\"." (dolist (data mailcap--computed-mime-data) (dolist (info (cdr data)) (setq type (cdr (assq 'type (cdr info)))) - (unless (string-match-p "\\*" type) + (unless (string-search "*" type) (push type res)))) (nreverse res))))) diff --git a/lisp/net/mairix.el b/lisp/net/mairix.el index e1d35c2a85a..727aa55de58 100644 --- a/lisp/net/mairix.el +++ b/lisp/net/mairix.el @@ -422,7 +422,7 @@ with m:msgid of the current article and enabled threads." (while (string-match "[<>]" mid) (setq mid (replace-match "" t t mid))) ;; mairix somehow does not like '$' in message-id - (when (string-match "\\$" mid) + (when (string-search "$" mid) (setq mid (concat mid "="))) (while (string-match "\\$" mid) (setq mid (replace-match "=," t t mid))) diff --git a/lisp/net/pop3.el b/lisp/net/pop3.el index cb49f75c81d..a267ac319b6 100644 --- a/lisp/net/pop3.el +++ b/lisp/net/pop3.el @@ -551,8 +551,8 @@ Returns the process associated with the connection." (when result (let ((response (plist-get (cdr result) :greeting))) (setq pop3-timestamp - (substring response (or (string-match "<" response) 0) - (+ 1 (or (string-match ">" response) -1))))) + (substring response (or (string-search "<" response) 0) + (+ 1 (or (string-search ">" response) -1))))) (set-process-query-on-exit-flag (car result) nil) (erase-buffer) (car result))))) diff --git a/lisp/net/soap-client.el b/lisp/net/soap-client.el index f5480afb698..de1cd9d320f 100644 --- a/lisp/net/soap-client.el +++ b/lisp/net/soap-client.el @@ -1938,7 +1938,7 @@ This is a specialization of `soap-decode-type' for (e-name (soap-xs-element-name element)) ;; Heuristic: guess if we need to decode using local ;; namespaces. - (use-fq-names (string-match ":" (symbol-name (car node)))) + (use-fq-names (string-search ":" (symbol-name (car node)))) (children (if e-name (if use-fq-names ;; Find relevant children diff --git a/lisp/net/socks.el b/lisp/net/socks.el index 1da1d31d678..78a261fd83e 100644 --- a/lisp/net/socks.el +++ b/lisp/net/socks.el @@ -277,7 +277,7 @@ (setq version (process-get proc 'socks-server-protocol)) (cond ((equal version 'http) - (if (not (string-match "\r\n\r\n" string)) + (if (not (string-search "\r\n\r\n" string)) nil ; Need to spin some more (process-put proc 'socks-state socks-state-connected) (process-put proc 'socks-reply 0) diff --git a/lisp/nxml/nxml-outln.el b/lisp/nxml/nxml-outln.el index 6dca34a80f2..c265b19cf05 100644 --- a/lisp/nxml/nxml-outln.el +++ b/lisp/nxml/nxml-outln.el @@ -633,7 +633,7 @@ non-transparent child section." tag-qnames)))) (defun nxml-highlighted-qname (qname) - (let ((colon (string-match ":" qname))) + (let ((colon (string-search ":" qname))) (if colon (concat (propertize (substring qname 0 colon) 'face diff --git a/lisp/nxml/rng-cmpct.el b/lisp/nxml/rng-cmpct.el index d820d1b99b5..dd3000773fd 100644 --- a/lisp/nxml/rng-cmpct.el +++ b/lisp/nxml/rng-cmpct.el @@ -179,7 +179,7 @@ Return a pattern." (setq rng-c-default-namespace rng-c-inherit-namespace))) (defun rng-c-expand-name (prefixed-name) - (let ((i (string-match ":" prefixed-name))) + (let ((i (string-search ":" prefixed-name))) (rng-make-name (rng-c-lookup-prefix (substring prefixed-name 0 i)) @@ -222,7 +222,7 @@ and URI is a symbol.") (cdr binding))) (defun rng-c-expand-datatype (prefixed-name) - (let ((i (string-match ":" prefixed-name))) + (let ((i (string-search ":" prefixed-name))) (rng-make-datatype (rng-c-lookup-datatype-prefix (substring prefixed-name 0 i)) (substring prefixed-name (+ i 1))))) diff --git a/lisp/nxml/rng-uri.el b/lisp/nxml/rng-uri.el index fda481fa281..24f4d2ec443 100644 --- a/lisp/nxml/rng-uri.el +++ b/lisp/nxml/rng-uri.el @@ -93,7 +93,7 @@ Signal an error if URI is not a valid file URL." (rng-uri-error "`?' not escaped in file URI `%s'" uri)) (when fragment-id (rng-uri-error "URI `%s' has a fragment identifier" uri)) - (when (string-match ";" path) + (when (string-search ";" path) (rng-uri-error "`;' not escaped in URI `%s'" uri)) (when (string-match "%2[fF]" path) ;; 2f is hex code of slash (rng-uri-error "Escaped slash in URI `%s'" uri)) @@ -110,7 +110,7 @@ Signal an error if URI is not a valid file URL." (rng-uri-unescape-unibyte-replace path 2)) (t (rng-uri-unescape-unibyte path)))) - (when (string-match "\000" path) + (when (string-search "\000" path) (rng-uri-error "URI `%s' has NUL character in path" uri)) (when (eq pattern 'match) (setq path diff --git a/lisp/obsolete/complete.el b/lisp/obsolete/complete.el index 1c1167db89b..2d3be2dd9a4 100644 --- a/lisp/obsolete/complete.el +++ b/lisp/obsolete/complete.el @@ -243,7 +243,7 @@ second TAB brings up the `*Completions*' buffer." (when (and partial-completion-mode (null PC-env-vars-alist)) (setq PC-env-vars-alist (mapcar (lambda (string) - (let ((d (string-match "=" string))) + (let ((d (string-search "=" string))) (cons (concat "$" (substring string 0 d)) (and d (substring string (1+ d)))))) process-environment)))) @@ -575,7 +575,7 @@ GOTO-END is non-nil, however, it instead replaces up to END." p (+ p (length PC-ndelims-regex) 1))))) (setq p 0) (if filename - (while (setq p (string-match "\\\\\\*" regex p)) + (while (setq p (string-search "\\*" regex p)) (setq regex (concat (substring regex 0 p) "[^/]*" (substring regex (+ p 2)))))) diff --git a/lisp/obsolete/longlines.el b/lisp/obsolete/longlines.el index 9676d6b28e9..9bf68456826 100644 --- a/lisp/obsolete/longlines.el +++ b/lisp/obsolete/longlines.el @@ -393,11 +393,11 @@ compatibility with `format-alist', and is ignored." "Return a copy of STRING with each soft newline replaced by a space. Hard newlines are left intact." (let* ((str (copy-sequence string)) - (pos (string-match "\n" str))) + (pos (string-search "\n" str))) (while pos (if (null (get-text-property pos 'hard str)) (aset str pos ? )) - (setq pos (string-match "\n" str (1+ pos)))) + (setq pos (string-search "\n" str (1+ pos)))) str)) ;;; Auto wrap diff --git a/lisp/obsolete/nnir.el b/lisp/obsolete/nnir.el index caeca988810..9aab1e7c9f5 100644 --- a/lisp/obsolete/nnir.el +++ b/lisp/obsolete/nnir.el @@ -509,7 +509,7 @@ construct the vector entries." (vector (gnus-group-full-name group server) (if (string-match "\\`nnmaildir:" (gnus-group-server server)) (nnmaildir-base-name-to-article-number - (substring article 0 (string-match ":" article)) + (substring article 0 (string-search ":" article)) group nil) (string-to-number article)) (string-to-number score))))) diff --git a/lisp/obsolete/terminal.el b/lisp/obsolete/terminal.el index dbfc79bf913..0167a00066b 100644 --- a/lisp/obsolete/terminal.el +++ b/lisp/obsolete/terminal.el @@ -1222,7 +1222,7 @@ of the terminal-emulator" (cond ((string-match "\\`[-a-zA-Z0-9+=_.@/:]+\\'" string) string) - ((not (string-match "[$]" string)) + ((not (string-search "$" string)) ;; "[\"\\]" are special to sh and the lisp reader in the same way (prin1-to-string string)) (t diff --git a/lisp/obsolete/tpu-edt.el b/lisp/obsolete/tpu-edt.el index 1340618f055..e0e89c390ea 100644 --- a/lisp/obsolete/tpu-edt.el +++ b/lisp/obsolete/tpu-edt.el @@ -1415,9 +1415,9 @@ If an argument is specified, don't set the search direction." ;; if using regexp, eliminate upper case forms (\B \W \S.) (if tpu-regexp-p (let ((pat (copy-sequence string)) (case-fold-search nil) (pos 0)) - (while (setq pos (string-match "\\\\\\\\" pat)) (aset pat (+ 1 pos) ?.)) - (while (setq pos (string-match "\\\\B" pat)) (aset pat (+ 1 pos) ?.)) - (while (setq pos (string-match "\\\\W" pat)) (aset pat (+ 1 pos) ?.)) + (while (setq pos (string-search "\\\\" pat)) (aset pat (+ 1 pos) ?.)) + (while (setq pos (string-search "\\B" pat)) (aset pat (+ 1 pos) ?.)) + (while (setq pos (string-search "\\W" pat)) (aset pat (+ 1 pos) ?.)) (while (setq pos (string-match "\\\\S." pat)) (aset pat (+ 1 pos) ?.) (aset pat (+ 2 pos) ?.)) (string-equal pat (downcase pat))) diff --git a/lisp/obsolete/url-ns.el b/lisp/obsolete/url-ns.el index b62ad829990..6cd6693fc43 100644 --- a/lisp/obsolete/url-ns.el +++ b/lisp/obsolete/url-ns.el @@ -31,7 +31,7 @@ ;;;###autoload (defun isPlainHostName (host) - (not (string-match "\\." host))) + (not (string-search "." host))) ;;;###autoload (defun dnsDomainIs (host dom) diff --git a/lisp/pcmpl-unix.el b/lisp/pcmpl-unix.el index e1d104f74ff..49dc2d2fc6c 100644 --- a/lisp/pcmpl-unix.el +++ b/lisp/pcmpl-unix.el @@ -214,7 +214,7 @@ Includes files as well as host names followed by a colon." (list string) (completion-table-subvert (pcomplete-all-entries) "" "/ssh:"))) - ((string-match "/" string) ; Local file name. + ((string-search "/" string) ; Local file name. (pcomplete-all-entries)) (t ;Host name or local file name. (append (all-completions string (pcomplete-all-entries)) diff --git a/lisp/play/dunnet.el b/lisp/play/dunnet.el index 3bb8bf0c82b..9d5ee261976 100644 --- a/lisp/play/dunnet.el +++ b/lisp/play/dunnet.el @@ -2170,7 +2170,7 @@ other words." (let (pos ret-list end-pos) (setq pos 0) (setq ret-list nil) - (while (setq end-pos (string-match " " (substring strin pos))) + (while (setq end-pos (string-search " " (substring strin pos))) (setq end-pos (+ end-pos pos)) (if (not (= end-pos pos)) (setq ret-list (append ret-list (list @@ -2269,7 +2269,7 @@ except for the verb." startlist (if (string= (substring dirstring 0 1) "/") (dun-get-path (substring dirstring 1) (append startlist (list "/"))) - (if (not (setq slash (string-match "/" dirstring))) + (if (not (setq slash (string-search "/" dirstring))) (append startlist (list dirstring)) (dun-get-path (substring dirstring (1+ slash)) (append startlist @@ -2348,7 +2348,7 @@ Also prints current score to let user know he has scored." (princ dun-line) (if (eq (dun-parse2 nil dun-unix-verbs dun-line) -1) (progn - (if (setq esign (string-match "=" dun-line)) + (if (setq esign (string-search "=" dun-line)) (dun-doassign dun-line esign) (dun-mprinc (car dun-line-list)) (dun-mprincl ": not found."))))) @@ -2380,21 +2380,21 @@ Also prints current score to let user know he has scored." (dun-mprinc line) (dun-mprincl " : not found.")) - (if (not (setq epoint (string-match ")" line))) + (if (not (setq epoint (string-search ")" line))) (if (string= (substring line (1+ esign) (+ esign 2)) "\"") (progn (setq afterq (substring line (+ esign 2))) (setq epoint (+ - (string-match "\"" afterq) + (string-search "\"" afterq) (+ esign 3)))) - (if (not (setq epoint (string-match " " line))) + (if (not (setq epoint (string-search " " line))) (setq epoint (length line)))) (setq epoint (1+ epoint)) (while (and (not (= epoint (length line))) - (setq i (string-match ")" (substring line epoint)))) + (setq i (string-search ")" (substring line epoint)))) (setq epoint (+ epoint i 1)))) (setq value (substring line (1+ esign) epoint)) (dun-eval varname value))))) @@ -2788,7 +2788,7 @@ drwxr-xr-x 3 root staff 2048 Jan 1 1970 ..") (cond ((null (setq args (car args))) (dun-mprincl "Usage: cat ")) - ((string-match-p "/" args) + ((string-search "/" args) (dun-mprincl "cat: only files in current directory allowed.")) ((and (> dun-cdroom 0) (string= args "description")) (dun-mprincl (car (nth dun-cdroom dun-rooms)))) @@ -3110,7 +3110,7 @@ File not found"))) (setq dun-line (downcase (dun-read-line))) (if (eq (dun-parse2 nil dun-unix-verbs dun-line) -1) (let (esign) - (if (setq esign (string-match "=" dun-line)) + (if (setq esign (string-search "=" dun-line)) (dun-doassign dun-line esign) (dun-mprinc (car dun-line-list)) (dun-mprincl ": not found."))))) diff --git a/lisp/progmodes/ebnf2ps.el b/lisp/progmodes/ebnf2ps.el index a00440d898c..884104a16f7 100644 --- a/lisp/progmodes/ebnf2ps.el +++ b/lisp/progmodes/ebnf2ps.el @@ -4337,7 +4337,7 @@ end (let ((len (1- (length str))) (index 0) new start fmt) - (while (setq start (string-match "%" str index)) + (while (setq start (string-search "%" str index)) (setq fmt (if (< start len) (aref str (1+ start)) ?\?) new (concat new (substring str index start) diff --git a/lisp/progmodes/gdb-mi.el b/lisp/progmodes/gdb-mi.el index 97596d0d278..67ad39b7f46 100644 --- a/lisp/progmodes/gdb-mi.el +++ b/lisp/progmodes/gdb-mi.el @@ -1382,7 +1382,7 @@ With arg, enter name of variable to be watched in the minibuffer." (string-match "\\(\\S-+\\)" text) (let* ((var (nth (- (count-lines (point-min) (point)) 2) gdb-var-list)) (varnum (car var))) - (if (string-match "\\." (car var)) + (if (string-search "." (car var)) (message-box "Can only delete a root expression") (gdb-var-delete-1 var varnum))))) @@ -1479,14 +1479,14 @@ With arg, enter name of variable to be watched in the minibuffer." TEXT is the text of the button we clicked on, a + or - item. TOKEN is data related to this node. INDENT is the current indentation depth." - (cond ((string-match "\\+" text) ;expand this node + (cond ((string-search "+" text) ;expand this node (let* ((var (assoc token gdb-var-list)) (expr (nth 1 var)) (children (nth 2 var))) (if (or (<= (string-to-number children) gdb-max-children) (y-or-n-p (format "%s has %s children. Continue? " expr children))) (gdb-var-list-children token)))) - ((string-match "-" text) ;contract this node + ((string-search "-" text) ;contract this node (dolist (var gdb-var-list) (if (string-match (concat token "\\.") (car var)) (setq gdb-var-list (delq var gdb-var-list)))) @@ -2416,7 +2416,7 @@ rule from an incomplete data stream. The parser will stay in this state until the end of the current result or async record is reached." (when (< gdbmi-bnf-offset (length gud-marker-acc)) ;; Search the data stream for the end of the current record: - (let* ((newline-pos (string-match "\n" gud-marker-acc gdbmi-bnf-offset)) + (let* ((newline-pos (string-search "\n" gud-marker-acc gdbmi-bnf-offset)) (is-progressive (equal (cdr class-command) 'progressive)) (is-complete (not (null newline-pos))) result-str) diff --git a/lisp/progmodes/gud.el b/lisp/progmodes/gud.el index 05ad82acc4a..08814ebcaaa 100644 --- a/lisp/progmodes/gud.el +++ b/lisp/progmodes/gud.el @@ -3150,7 +3150,7 @@ Obeying it means displaying in another window the specified file and line." (buffer-substring (region-beginning) (region-end)) (apply gud-find-expr-function args)))) (save-match-data - (if (string-match "\n" expr) + (if (string-search "\n" expr) (error "Expression must not include a newline")) (with-current-buffer gud-comint-buffer (save-excursion diff --git a/lisp/progmodes/idlw-help.el b/lisp/progmodes/idlw-help.el index db76df96a56..c53b9a4775c 100644 --- a/lisp/progmodes/idlw-help.el +++ b/lisp/progmodes/idlw-help.el @@ -495,7 +495,7 @@ It collects and prints the diagnostics messages." ((and (memq cw '(function-keyword procedure-keyword)) (stringp this-word) (string-match "\\S-" this-word) - (not (string-match "!" this-word))) + (not (string-search "!" this-word))) (cond ((or (= (char-before beg) ?/) (save-excursion (goto-char end) (looking-at "[ \t]*="))) diff --git a/lisp/progmodes/idlw-shell.el b/lisp/progmodes/idlw-shell.el index ad8feb988f5..eb88f25dfd6 100644 --- a/lisp/progmodes/idlw-shell.el +++ b/lisp/progmodes/idlw-shell.el @@ -967,7 +967,7 @@ IDL has currently stepped.") ;; Strip those pesky ctrl-m's. (add-hook 'comint-output-filter-functions (lambda (string) - (when (string-match "\r" string) + (when (string-search "\r" string) (let ((pmark (process-mark (get-buffer-process (current-buffer))))) (save-excursion @@ -1409,7 +1409,7 @@ Remove everything to the first newline, and all lines with % in front of them, with optional follow-on lines starting with two spaces. This works well enough, since any print output typically arrives before error messages, etc." - (setq output (substring output (string-match "\n" output))) + (setq output (substring output (string-search "\n" output))) (while (string-match "\\(\n\\|\\`\\)%.*\\(\n .*\\)*" output) (setq output (replace-match "" nil t output))) (unless @@ -1431,12 +1431,12 @@ and then calls `idlwave-shell-send-command' for any pending commands." (unwind-protect (progn ;; Ring the bell if necessary - (while (setq p (string-match "\C-G" string)) + (while (setq p (string-search "\C-G" string)) (ding) (aset string p ?\C-j )) (if idlwave-shell-hide-output (save-excursion - (while (setq p (string-match "\C-M" string)) + (while (setq p (string-search "\C-M" string)) (aset string p ?\ )) (set-buffer (get-buffer-create idlwave-shell-hidden-output-buffer)) @@ -1445,7 +1445,7 @@ and then calls `idlwave-shell-send-command' for any pending commands." (comint-output-filter proc string)) ;; Watch for magic - need to accumulate the current line ;; since it may not be sent all at once. - (if (string-match "\n" string) + (if (string-search "\n" string) (progn (if idlwave-shell-use-input-mode-magic (idlwave-shell-input-mode-magic diff --git a/lisp/progmodes/idlwave.el b/lisp/progmodes/idlwave.el index b55a98af0b3..55e712dd77d 100644 --- a/lisp/progmodes/idlwave.el +++ b/lisp/progmodes/idlwave.el @@ -2547,7 +2547,7 @@ If there is no label point is not moved and nil is returned." (end (idlwave-find-key ":" 1 'nomark eos))) (if (and end (= (nth 0 (parse-partial-sexp start end)) 0) - (not (string-match "\\?" (buffer-substring start end))) + (not (string-search "?" (buffer-substring start end))) (not (string-match "^::" (buffer-substring end eos)))) (progn (forward-char) @@ -7677,9 +7677,9 @@ arg, the class property is cleared out." (interactive "P") (idlwave-routines) - (if (string-match "->" (buffer-substring - (max (point-min) (1- (point))) - (min (+ 2 (point)) (point-max)))) + (if (string-search "->" (buffer-substring + (max (point-min) (1- (point))) + (min (+ 2 (point)) (point-max)))) ;; Cursor is on an arrow (if (get-text-property (point) 'idlwave-class) ;; arrow has class property diff --git a/lisp/progmodes/octave.el b/lisp/progmodes/octave.el index aff3066c698..b1a5f301587 100644 --- a/lisp/progmodes/octave.el +++ b/lisp/progmodes/octave.el @@ -895,7 +895,7 @@ startup file, `~/.emacs-octave'." (defun inferior-octave-completion-at-point () "Return the data to complete the Octave symbol at point." ;; https://debbugs.gnu.org/14300 - (unless (string-match-p "/" (or (comint--match-partial-filename) "")) + (unless (string-search "/" (or (comint--match-partial-filename) "")) (let ((beg (save-excursion (skip-syntax-backward "w_" (comint-line-beginning-position)) (point))) diff --git a/lisp/progmodes/sh-script.el b/lisp/progmodes/sh-script.el index 91db4ae21cb..2f98b9c53c1 100644 --- a/lisp/progmodes/sh-script.el +++ b/lisp/progmodes/sh-script.el @@ -2672,7 +2672,7 @@ t means to return a list of all possible completions of STRING. (or sh-shell-variables-initialized (sh-shell-initialize-variables)) (nconc (mapcar (lambda (var) - (substring var 0 (string-match "=" var))) + (substring var 0 (string-search "=" var))) process-environment) sh-shell-variables)))) (complete-with-action code vars string predicate))) diff --git a/lisp/progmodes/sql.el b/lisp/progmodes/sql.el index b9012166a52..d144d68b571 100644 --- a/lisp/progmodes/sql.el +++ b/lisp/progmodes/sql.el @@ -1573,7 +1573,7 @@ statement. The format of variable should be a valid face))) (defun sql-regexp-abbrev (keyword) - (let ((brk (string-match "[~]" keyword)) + (let ((brk (string-search "~" keyword)) (len (length keyword)) (sep "\\(?:") re i) diff --git a/lisp/progmodes/xscheme.el b/lisp/progmodes/xscheme.el index 613863dd613..70763319840 100644 --- a/lisp/progmodes/xscheme.el +++ b/lisp/progmodes/xscheme.el @@ -936,7 +936,7 @@ the remaining input.") (setq call-noexcursion nil) (with-current-buffer (process-buffer proc) (cond ((eq xscheme-process-filter-state 'idle) - (let ((start (string-match "\e" xscheme-filter-input))) + (let ((start (string-search "\e" xscheme-filter-input))) (if start (progn (xscheme-process-filter-output @@ -960,7 +960,7 @@ the remaining input.") (xscheme-process-filter-output ?\e char) (setq xscheme-process-filter-state 'idle))))))) ((eq xscheme-process-filter-state 'reading-string) - (let ((start (string-match "\e" xscheme-filter-input))) + (let ((start (string-search "\e" xscheme-filter-input))) (if start (let ((string (concat xscheme-string-accumulator diff --git a/lisp/replace.el b/lisp/replace.el index c67877efd5d..1d6f091dc71 100644 --- a/lisp/replace.el +++ b/lisp/replace.el @@ -310,7 +310,7 @@ the original string if not." ;; but not after (quote foo). (and (eq (car-safe (car pos)) 'quote) (not (= ?\( (aref to 0))))) - (eq (string-match " " to (cdr pos)) + (eq (string-search " " to (cdr pos)) (cdr pos))) (1+ (cdr pos)) (cdr pos)))) @@ -633,13 +633,13 @@ Arguments REGEXP, START, END, and REGION-NONCONTIGUOUS-P are passed to (if (listp to-strings) (setq replacements to-strings) (while (/= (length to-strings) 0) - (if (string-match " " to-strings) + (if (string-search " " to-strings) (setq replacements (append replacements (list (substring to-strings 0 - (string-match " " to-strings)))) + (string-search " " to-strings)))) to-strings (substring to-strings - (1+ (string-match " " to-strings)))) + (1+ (string-search " " to-strings)))) (setq replacements (append replacements (list to-strings)) to-strings "")))) (perform-replace regexp replacements t t nil n nil start end nil region-noncontiguous-p))) diff --git a/lisp/shell.el b/lisp/shell.el index 5aab80d1031..292f267d2e1 100644 --- a/lisp/shell.el +++ b/lisp/shell.el @@ -1252,7 +1252,7 @@ Returns t if successful." (list start end (lambda (string pred action) - (if (string-match "/" string) + (if (string-search "/" string) (completion-file-name-table string pred action) (complete-with-action action completions string pred))) :exit-function @@ -1328,7 +1328,7 @@ Returns non-nil if successful." (looking-at "\\$?[({]*") (match-end 0))) (variables (mapcar (lambda (x) - (substring x 0 (string-match "=" x))) + (substring x 0 (string-search "=" x))) process-environment)) (suffix (pcase (char-before start) (?\{ "}") (?\( ")") (_ "")))) (list start end variables diff --git a/lisp/simple.el b/lisp/simple.el index 3ad8634975f..985beb06fc9 100644 --- a/lisp/simple.el +++ b/lisp/simple.el @@ -4272,11 +4272,11 @@ the contents are inserted into the buffer anyway. Optional arguments ACTION and FRAME are as for `display-buffer', and are used only if a pop-up buffer is displayed." - (cond ((and (stringp message) (not (string-match "\n" message))) + (cond ((and (stringp message) (not (string-search "\n" message))) ;; Trivial case where we can use the echo area (message "%s" message)) ((and (stringp message) - (= (string-match "\n" message) (1- (length message)))) + (= (string-search "\n" message) (1- (length message)))) ;; Trivial case where we can just remove single trailing newline (message "%s" (substring message 0 (1- (length message))))) (t diff --git a/lisp/speedbar.el b/lisp/speedbar.el index 34fbec9c218..3cc3e276067 100644 --- a/lisp/speedbar.el +++ b/lisp/speedbar.el @@ -3270,7 +3270,7 @@ Handles end-of-sublist smartly." Clicking this button expands or contracts a directory. TEXT is the button clicked which has either a + or -. TOKEN is the directory to be expanded. INDENT is the current indentation level." - (cond ((string-match "\\+" text) ;we have to expand this dir + (cond ((string-search "+" text) ;we have to expand this dir (setq speedbar-shown-directories (cons (expand-file-name (concat (speedbar-line-directory indent) token "/")) @@ -3283,7 +3283,7 @@ expanded. INDENT is the current indentation level." (speedbar-default-directory-list (concat (speedbar-line-directory indent) token "/") (1+ indent))))) - ((string-match "-" text) ;we have to contract this node + ((string-search "-" text) ;we have to contract this node (speedbar-reset-scanners) (let ((oldl speedbar-shown-directories) (newl nil) @@ -3317,7 +3317,7 @@ INDENT is the current indentation level and is unused." The parameter TEXT and TOKEN are required, where TEXT is the button clicked, and TOKEN is the file to expand. INDENT is the current indentation level." - (cond ((string-match "\\+" text) ;we have to expand this file + (cond ((string-search "+" text) ;we have to expand this file (let* ((fn (expand-file-name (concat (speedbar-line-directory indent) token))) (lst (speedbar-fetch-dynamic-tags fn))) @@ -3329,7 +3329,7 @@ indentation level." (save-excursion (end-of-line) (forward-char 1) (funcall (car lst) indent (cdr lst))))))) - ((string-match "-" text) ;we have to contract this node + ((string-search "-" text) ;we have to contract this node (speedbar-change-expand-button-char ?+) (speedbar-delete-subblock indent)) (t (error "Ooops... not sure what to do"))) @@ -3358,14 +3358,14 @@ INDENT is the current indentation level." "Expand a tag sublist. Imenu will return sub-lists of specialized tag types. Etags does not support this feature. TEXT will be the button string. TOKEN will be the list, and INDENT is the current indentation level." - (cond ((string-match "\\+" text) ;we have to expand this file + (cond ((string-search "+" text) ;we have to expand this file (speedbar-change-expand-button-char ?-) (speedbar-with-writable (save-excursion (end-of-line) (forward-char 1) (speedbar-insert-generic-list indent token 'speedbar-tag-expand 'speedbar-tag-find)))) - ((string-match "-" text) ;we have to contract this node + ((string-search "-" text) ;we have to contract this node (speedbar-change-expand-button-char ?+) (speedbar-delete-subblock indent)) (t (error "Ooops... not sure what to do"))) diff --git a/lisp/subr.el b/lisp/subr.el index 87298b5cfde..1cae3ee1a60 100644 --- a/lisp/subr.el +++ b/lisp/subr.el @@ -4808,7 +4808,7 @@ It understands Emacs Lisp quoting within STRING, such that (split-string-and-unquote (combine-and-quote-strings strs)) == strs The SEPARATOR regexp defaults to \"\\s-+\"." (let ((sep (or separator "\\s-+")) - (i (string-match "\"" string))) + (i (string-search "\"" string))) (if (null i) (split-string string sep t) ; no quoting: easy (append (unless (eq i 0) (split-string (substring string 0 i) sep t)) diff --git a/lisp/tar-mode.el b/lisp/tar-mode.el index 3f0cca0ab7a..411c71cd8c4 100644 --- a/lisp/tar-mode.el +++ b/lisp/tar-mode.el @@ -962,7 +962,7 @@ return nil. Otherwise point is returned." (new-buffer-file-name (expand-file-name ;; `:' is not allowed on Windows (concat tarname "!" - (if (string-match "/" name) + (if (string-search "/" name) name ;; Make sure `name' contains a / ;; so set-auto-mode doesn't try diff --git a/lisp/term.el b/lisp/term.el index 27f0bb1be3b..b3870a814d2 100644 --- a/lisp/term.el +++ b/lisp/term.el @@ -3488,9 +3488,9 @@ The top-most line is line 0." ((= (aref string 0) ?\032) ;; gdb (when invoked with -fullname) prints: ;; \032\032FULLFILENAME:LINENUMBER:CHARPOS:BEG_OR_MIDDLE:PC\n - (let* ((first-colon (string-match ":" string 1)) + (let* ((first-colon (string-search ":" string 1)) (second-colon - (string-match ":" string (1+ first-colon))) + (string-search ":" string (1+ first-colon))) (filename (substring string 1 first-colon)) (fileline (string-to-number (substring string (1+ first-colon) second-colon)))) @@ -4307,7 +4307,7 @@ well as the newer ports COM10 and higher." (when (or (null x) (and (stringp x) (zerop (length x)))) (error "No serial port selected")) (when (not (or (serial-port-is-file-p) - (string-match "\\\\" x))) + (string-search "\\" x))) (setq x (concat "\\\\.\\" x))) x)) diff --git a/lisp/textmodes/bibtex.el b/lisp/textmodes/bibtex.el index 31186fb4fac..5cece1aa3c6 100644 --- a/lisp/textmodes/bibtex.el +++ b/lisp/textmodes/bibtex.el @@ -3962,7 +3962,7 @@ Optional arg COMMA is as in `bibtex-enclosing-field'. It is t for interactive calls." (interactive (list nil t)) (unless field (setq field (car (bibtex-find-text-internal nil nil comma)))) - (if (string-match "@" field) + (if (string-search "@" field) (cond ((bibtex-string= field "@string") (message "String definition")) ((bibtex-string= field "@preamble") diff --git a/lisp/textmodes/ispell.el b/lisp/textmodes/ispell.el index 4c64531ea35..67852998f42 100644 --- a/lisp/textmodes/ispell.el +++ b/lisp/textmodes/ispell.el @@ -2497,7 +2497,7 @@ if defined." "Customize `ispell-alternate-dictionary' to set yours."))) (let* ((process-connection-type ispell-use-ptys-p) - (wild-p (string-match "\\*" word)) + (wild-p (string-search "*" word)) (look-p (and ispell-look-p ; Only use look for an exact match. (or ispell-have-new-look (not wild-p)))) (prog (if look-p ispell-look-command ispell-grep-command)) @@ -2560,7 +2560,7 @@ if defined." (continue t) end) (while continue - (setq end (string-match "\n" output start)) ; get text up to the newline. + (setq end (string-search "\n" output start)) ; get text up to the newline. ;; If we get out of sync and ispell-filter-continue is asserted when we ;; are not continuing, treat the next item as a separate list. When ;; ispell-filter-continue is asserted, ispell-filter *should* always be a @@ -2732,11 +2732,11 @@ Optional third arg SHIFT is an offset to apply based on previous corrections." (if (eq type ?#) (setq count 0) ; no misses for type # (setq count (string-to-number output) ; get number of misses. - output (substring output (1+ (string-match " " output 1))))) + output (substring output (1+ (string-search " " output 1))))) (setq offset (string-to-number output)) (setq output (if (eq type ?#) ; No miss or guess list. nil - (substring output (1+ (string-match " " output 1))))) + (substring output (1+ (string-search " " output 1))))) (while output (let ((end (string-match ", \\|\\($\\)" output))) ; end of miss/guess. (setq cur-count (1+ cur-count)) @@ -4077,7 +4077,7 @@ Includes LaTeX/Nroff modes and extended character mode." (ispell-send-string "+\n~tex\n")) ((string-match "nroff-mode" string) (ispell-send-string "-\n~nroff\n")) - ((string-match "~" string) ; Set extended character mode. + ((string-search "~" string) ; Set extended character mode. (ispell-send-string (concat string "\n"))) (t (message "Invalid Ispell Parsing argument!") (sit-for 2)))))))) diff --git a/lisp/textmodes/reftex-cite.el b/lisp/textmodes/reftex-cite.el index 650d11d4aca..895064b82f3 100644 --- a/lisp/textmodes/reftex-cite.el +++ b/lisp/textmodes/reftex-cite.el @@ -718,7 +718,7 @@ While entering the regexp, completion on knows citation keys is possible. (insert string)) ;; Reposition cursor? - (when (string-match "\\?" string) + (when (string-search "?" string) (search-backward "?") (delete-char 1)) diff --git a/lisp/textmodes/reftex-parse.el b/lisp/textmodes/reftex-parse.el index 0157f8443aa..9def10cee05 100644 --- a/lisp/textmodes/reftex-parse.el +++ b/lisp/textmodes/reftex-parse.el @@ -757,7 +757,7 @@ if the information is exact (t) or approximate (nil)." (while (and (setq tail (memq (assq 'toc (cdr tail)) tail)) (setq entry (car tail)) (>= (nth 5 entry) level)) - (setq star (string-match "\\*" (nth 6 entry)) + (setq star (string-search "*" (nth 6 entry)) context (nth 2 entry) section-number (reftex-section-number (nth 5 entry) star)) diff --git a/lisp/textmodes/reftex-ref.el b/lisp/textmodes/reftex-ref.el index 611102ecbac..19081825931 100644 --- a/lisp/textmodes/reftex-ref.el +++ b/lisp/textmodes/reftex-ref.el @@ -798,7 +798,7 @@ When called with 2 C-u prefix args, disable magic word recognition." (push (cons (current-buffer) buffer-invisibility-spec) reftex-buffers-with-changed-invisibility) (setq buffer-invisibility-spec nil)) - ((string-match "\r" (buffer-substring beg end)) + ((string-search "\r" (buffer-substring beg end)) ;; Invisible with selective display. We need to copy it. (let ((string (buffer-substring-no-properties beg end))) (switch-to-buffer "*RefTeX Context Copy*") diff --git a/lisp/textmodes/reftex.el b/lisp/textmodes/reftex.el index c732299361c..1cb2cf40c3b 100644 --- a/lisp/textmodes/reftex.el +++ b/lisp/textmodes/reftex.el @@ -813,7 +813,7 @@ This enforces rescanning the buffer on next use." (setq wordlist (nthcdr 4 entry))) (if (and (stringp fmt) - (string-match "@" fmt)) + (string-search "@" fmt)) ;; Special syntax for specifying a label format (setq fmt (split-string fmt "@+")) (setq fmt (list "\\label{%s}" fmt))) diff --git a/lisp/textmodes/tex-mode.el b/lisp/textmodes/tex-mode.el index d9d8059f960..5169377c136 100644 --- a/lisp/textmodes/tex-mode.el +++ b/lisp/textmodes/tex-mode.el @@ -2072,7 +2072,7 @@ Return the process in which TeX is running." (let* ((cmd (eval command t)) (proc (tex-shell-proc)) (buf (process-buffer proc)) - (star (string-match "\\*" cmd)) + (star (string-search "*" cmd)) (string (concat (if (null file) @@ -2474,7 +2474,7 @@ Only applies the FSPEC to the args part of FORMAT." (defun tex-start-tex (command file &optional dir) "Start a TeX run, using COMMAND on FILE." - (let* ((star (string-match "\\*" command)) + (let* ((star (string-search "*" command)) (compile-command (if star (concat (substring command 0 star) @@ -2773,7 +2773,7 @@ so normally SUFFIX starts with one." ;; Not found, so split on first period. (concat (file-name-directory file-name) (substring file 0 - (string-match "\\." file)) + (string-search "." file)) suffix))) " ")) diff --git a/lisp/thingatpt.el b/lisp/thingatpt.el index 5bbf1a85b36..66bbfb0f9f6 100644 --- a/lisp/thingatpt.el +++ b/lisp/thingatpt.el @@ -492,7 +492,7 @@ looks like an email address, \"ftp://\" if it starts with (and (string-match "\\`[[:alnum:]]+\\'" str) (eq (char-before (car bounds)) ?<) (eq (char-after (cdr bounds)) ?>) - (not (string-match "~" (expand-file-name (concat "~" str)))) + (not (string-search "~" (expand-file-name (concat "~" str)))) (setq str (concat "mailto:" str))) ;; If it looks like news.example.com, treat it as news. (if (thing-at-point-newsgroup-p str) diff --git a/lisp/tmm.el b/lisp/tmm.el index 2040f522700..71082bd2f4b 100644 --- a/lisp/tmm.el +++ b/lisp/tmm.el @@ -268,7 +268,7 @@ Stores a list of all the shortcuts in the free variable `tmm-short-cuts'." (cdr elt))) (t (let* ((str (car elt)) - (paren (string-match "(" str)) + (paren (string-search "(" str)) (pos 0) (word 0) char) (catch 'done ; ??? is this slow? (while (and (or (not tmm-shortcut-words) ; no limit on words diff --git a/lisp/transient.el b/lisp/transient.el index 4087a0c68a6..5f441e80ddd 100644 --- a/lisp/transient.el +++ b/lisp/transient.el @@ -3073,7 +3073,7 @@ Optional support for popup buttons is also implemented here." ;; the definition, then we want to drop the space that ;; is reinserted above. False-positives are possible ;; for silly bindings like "-C-c C-c". - (unless (string-match-p " " key) + (unless (string-search " " key) (setq pre (string-replace " " "" pre)) (setq suf (string-replace " " "" suf))) (concat (propertize pre 'face 'default) diff --git a/lisp/url/url-auth.el b/lisp/url/url-auth.el index f291414e81b..06cfacc99d6 100644 --- a/lisp/url/url-auth.el +++ b/lisp/url/url-auth.el @@ -102,10 +102,10 @@ instead of the filename inheritance method." (byserv (setq retval (cdr-safe (assoc file byserv))) (if (and (not retval) - (string-match "/" file)) + (string-search "/" file)) (while (and byserv (not retval)) (setq data (car (car byserv))) - (if (or (not (string-match "/" data)) ; It's a realm - take it! + (if (or (not (string-search "/" data)) ; It's a realm - take it! (and (>= (length file) (length data)) (string= data (substring file 0 (length data))))) @@ -251,12 +251,12 @@ a match." (assoc dirkey keylist) ;; No exact match found. Continue to look for partial match if ;; dirkey is not a realm. - (and (string-match "/" dirkey) + (and (string-search "/" dirkey) (let (match) (while (and (null match) keylist) (if (or ;; Any realm candidate matches. Why? - (not (string-match "/" (caar keylist))) + (not (string-search "/" (caar keylist))) ;; Parent directory matches. (string-prefix-p (caar keylist) dirkey)) (setq match (car keylist)) diff --git a/lisp/url/url-news.el b/lisp/url/url-news.el index 49cc587590e..4fe909cadbc 100644 --- a/lisp/url/url-news.el +++ b/lisp/url/url-news.el @@ -106,7 +106,7 @@ (article (url-unhex-string (url-filename url)))) (url-news-open-host host port (url-user url) (url-password url)) (cond - ((string-match "@" article) ; Its a specific article + ((string-search "@" article) ; Its a specific article (setq buf (url-news-fetch-message-id host article))) ((string= article "") ; List all newsgroups (gnus)) diff --git a/lisp/url/url-util.el b/lisp/url/url-util.el index 8b79736d004..113ac2833bc 100644 --- a/lisp/url/url-util.el +++ b/lisp/url/url-util.el @@ -252,7 +252,7 @@ Will not do anything if `url-show-status' is nil." (while pairs (setq cur (car pairs) pairs (cdr pairs)) - (unless (string-match "=" cur) + (unless (string-search "=" cur) (setq cur (concat cur "="))) (when (string-match "=" cur) diff --git a/lisp/vc/vc-cvs.el b/lisp/vc/vc-cvs.el index ef607133e86..c8f36fb76ec 100644 --- a/lisp/vc/vc-cvs.el +++ b/lisp/vc/vc-cvs.el @@ -1173,7 +1173,7 @@ is non-nil." (mtime (file-attribute-modification-time (file-attributes file))) (parsed-time (progn (require 'parse-time) (parse-time-string (concat time " +0000"))))) - (cond ((and (not (string-match "\\+" time)) + (cond ((and (not (string-search "+" time)) (decoded-time-second parsed-time) ;; Compare just the seconds part of the file time, ;; since CVS file time stamp resolution is just 1 second. diff --git a/lisp/wid-browse.el b/lisp/wid-browse.el index 54b71c9f9f6..7ce0633b40b 100644 --- a/lisp/wid-browse.el +++ b/lisp/wid-browse.el @@ -218,7 +218,7 @@ Nothing is assumed about value." (error (prin1-to-string signal))))) (when (string-match "\n\\'" pp) (setq pp (substring pp 0 (1- (length pp))))) - (if (cond ((string-match "\n" pp) + (if (cond ((string-search "\n" pp) nil) ((> (length pp) (- (window-width) (current-column))) nil) diff --git a/lisp/woman.el b/lisp/woman.el index 0bc992d8f7f..fe9f8969c3e 100644 --- a/lisp/woman.el +++ b/lisp/woman.el @@ -418,7 +418,7 @@ As a special case, if PATHS is nil then replace it by calling (if (memq system-type '(windows-nt ms-dos)) (cond ((null paths) (mapcar #'woman-Cyg-to-Win (woman-parse-man.conf))) - ((string-match-p ";" paths) + ((string-search ";" paths) ;; Assume DOS-style path-list... (mapcan ; splice list into list (lambda (x) @@ -1939,12 +1939,12 @@ Optional argument REDRAW, if non-nil, forces mode line to be updated." (setq symbol (car p)) ; 1. name (if (functionp symbol) ; 2. command doc (if (setq doc (documentation symbol t)) - (substring doc 0 (string-match "\n" doc)) + (substring doc 0 (string-search "\n" doc)) "(not documented)")) (if (custom-variable-p symbol) ; 3. variable doc (if (setq doc (documentation-property symbol 'variable-documentation t)) - (substring doc 0 (string-match "\n" doc)))))) + (substring doc 0 (string-search "\n" doc)))))) (setq p (cdr p)))) ;; Output the result: (and (apropos-print t nil) @@ -1955,7 +1955,7 @@ Optional argument REDRAW, if non-nil, forces mode line to be updated." (defun WoMan-getpage-in-background (topic) "Use TOPIC to start WoMan from `Man-follow-manual-reference'." ;; topic is a string, generally of the form "section topic" - (let ((s (string-match " " topic))) + (let ((s (string-search " " topic))) (if s (setq topic (substring topic (1+ s)))) (woman topic))) @@ -3840,7 +3840,7 @@ Leave 1 blank line. Format paragraphs upto TO." ((eolp) ; extend line ;; Insert character INCLUDING TEXT PROPERTIES: ;; (insert (substring overlap i (1+ i))) - (let ((eol (string-match "\n" overlap i))) + (let ((eol (string-search "\n" overlap i))) (insert (substring overlap i eol)) (setq i (or eol imax))) ) diff --git a/lisp/xml.el b/lisp/xml.el index 4e2dd13ecbd..1b2d6557388 100644 --- a/lisp/xml.el +++ b/lisp/xml.el @@ -922,11 +922,11 @@ references and parameter-entity references." (progn (setq elem (match-string-no-properties 1 string) modifier (match-string-no-properties 2 string)) - (if (string-match-p "|" elem) + (if (string-search "|" elem) (setq elem (cons 'choice (mapcar 'xml-parse-elem-type (split-string elem "|")))) - (if (string-match-p "," elem) + (if (string-search "," elem) (setq elem (cons 'seq (mapcar 'xml-parse-elem-type (split-string elem ","))))))) diff --git a/test/lisp/emacs-lisp/check-declare-tests.el b/test/lisp/emacs-lisp/check-declare-tests.el index 9552bf0e397..276530fb4d3 100644 --- a/test/lisp/emacs-lisp/check-declare-tests.el +++ b/test/lisp/emacs-lisp/check-declare-tests.el @@ -106,11 +106,11 @@ (let ((res (buffer-string))) ;; Don't care too much about the format of the output, but ;; check that key information is present. - (should (string-match-p "foo-file" res)) - (should (string-match-p "foo-fun" res)) - (should (string-match-p "bar-file" res)) - (should (string-match-p "it wasn't" res)) - (should (string-match-p "999" res)))))) + (should (string-search "foo-file" res)) + (should (string-search "foo-fun" res)) + (should (string-search "bar-file" res)) + (should (string-search "it wasn't" res)) + (should (string-search "999" res)))))) (provide 'check-declare-tests) ;;; check-declare-tests.el ends here diff --git a/test/lisp/files-tests.el b/test/lisp/files-tests.el index db93250b17b..fb24b98595b 100644 --- a/test/lisp/files-tests.el +++ b/test/lisp/files-tests.el @@ -610,7 +610,7 @@ unquoted file names." (ert-deftest files-tests-file-name-non-special-dired-compress-handler () ;; `dired-compress-file' can get confused by filenames with ":" in ;; them, which causes this to fail on `windows-nt' systems. - (when (string-match-p ":" (expand-file-name temporary-file-directory)) + (when (string-search ":" (expand-file-name temporary-file-directory)) (ert-skip "FIXME: `dired-compress-file' unreliable when filenames contain `:'.")) (files-tests--with-temp-non-special (tmpfile nospecial) (let ((compressed (dired-compress-file nospecial))) diff --git a/test/lisp/net/network-stream-tests.el b/test/lisp/net/network-stream-tests.el index 1a4cc744f0c..4a0b23dd26f 100644 --- a/test/lisp/net/network-stream-tests.el +++ b/test/lisp/net/network-stream-tests.el @@ -128,7 +128,7 @@ (when prev (setq string (concat prev string)) (process-put proc 'previous-string nil))) - (if (and (not (string-match "\n" string)) + (if (and (not (string-search "\n" string)) (> (length string) 0)) (process-put proc 'previous-string string)) (let ((command (split-string string))) diff --git a/test/src/coding-tests.el b/test/src/coding-tests.el index 0309b2b1ad6..134f5676709 100644 --- a/test/src/coding-tests.el +++ b/test/src/coding-tests.el @@ -56,7 +56,7 @@ (set-buffer-multibyte nil) (insert (encode-coding-string "あ" 'euc-jp) "\xd" "\n") (decode-coding-region (point-min) (point-max) 'euc-jp-dos) - (should-not (string-match-p "\^M" (buffer-string))))) + (should-not (string-search "\^M" (buffer-string))))) ;; Return the contents (specified by CONTENT-TYPE; ascii, latin, or ;; binary) of a test file. -- cgit v1.2.3 From cfae83adacf0dd5309d20eb383e51a7ae48514b0 Mon Sep 17 00:00:00 2001 From: Stefan Kangas Date: Thu, 16 Sep 2021 15:35:10 +0200 Subject: ; Normalize some header comments --- lisp/bs.el | 5 ++--- lisp/delim-col.el | 2 +- lisp/leim/quail/persian.el | 2 +- lisp/mail/feedmail.el | 2 +- lisp/net/soap-client.el | 2 +- lisp/net/soap-inspect.el | 2 +- lisp/printing.el | 2 +- lisp/progmodes/antlr-mode.el | 2 +- lisp/progmodes/cl-font-lock.el | 1 - lisp/progmodes/ebnf2ps.el | 2 +- lisp/progmodes/gdb-mi.el | 3 +-- lisp/progmodes/verilog-mode.el | 2 +- lisp/ps-def.el | 2 +- lisp/ps-print.el | 2 +- lisp/ps-samp.el | 2 +- lisp/whitespace.el | 2 +- lisp/widget.el | 2 +- 17 files changed, 17 insertions(+), 20 deletions(-) (limited to 'lisp/progmodes/gdb-mi.el') diff --git a/lisp/bs.el b/lisp/bs.el index 494bc426188..ccb06bbdba0 100644 --- a/lisp/bs.el +++ b/lisp/bs.el @@ -4,6 +4,8 @@ ;; Author: Olaf Sylvester ;; Maintainer: emacs-devel@gnu.org ;; Keywords: convenience +;; Old-Version: 1.17 +;; URL: http://www.geekware.de/software/emacs ;; This file is part of GNU Emacs. @@ -22,9 +24,6 @@ ;;; Commentary: -;; Version: 1.17 -;; X-URL: http://www.geekware.de/software/emacs -;; ;; The bs-package contains a main function bs-show for popping up a ;; buffer in a way similar to `list-buffers' and `electric-buffer-list': ;; The new buffer offers a Buffer Selection Menu for manipulating diff --git a/lisp/delim-col.el b/lisp/delim-col.el index cd945d8de45..1153961468e 100644 --- a/lisp/delim-col.el +++ b/lisp/delim-col.el @@ -5,7 +5,7 @@ ;; Author: Vinicius Jose Latorre ;; Old-Version: 2.1 ;; Keywords: convenience text -;; X-URL: https://www.emacswiki.org/emacs/ViniciusJoseLatorre +;; URL: https://www.emacswiki.org/emacs/ViniciusJoseLatorre ;; This file is part of GNU Emacs. diff --git a/lisp/leim/quail/persian.el b/lisp/leim/quail/persian.el index cb1f6e3c78b..d058cfa61c4 100644 --- a/lisp/leim/quail/persian.el +++ b/lisp/leim/quail/persian.el @@ -3,7 +3,7 @@ ;; Copyright (C) 2011-2021 Free Software Foundation, Inc. ;; Author: Mohsen BANAN -;; X-URL: http://mohsen.1.banan.byname.net/contact +;; URL: http://mohsen.1.banan.byname.net/contact ;; Keywords: multilingual, input method, Farsi, Persian, keyboard diff --git a/lisp/mail/feedmail.el b/lisp/mail/feedmail.el index cec573642ec..083d8feae4e 100644 --- a/lisp/mail/feedmail.el +++ b/lisp/mail/feedmail.el @@ -7,7 +7,7 @@ ;; Author: Bill Carpenter ;; Version: 11 ;; Keywords: email, queue, mail, sendmail, message, spray, smtp, draft -;; X-URL: +;; URL: http://www.carpenter.org/feedmail/feedmail.html ;;; Commentary: diff --git a/lisp/net/soap-client.el b/lisp/net/soap-client.el index de1cd9d320f..6e10b5c4e30 100644 --- a/lisp/net/soap-client.el +++ b/lisp/net/soap-client.el @@ -8,7 +8,7 @@ ;; Version: 3.2.0 ;; Keywords: soap, web-services, comm, hypermedia ;; Package: soap-client -;; Homepage: https://github.com/alex-hhh/emacs-soap-client +;; URL: https://github.com/alex-hhh/emacs-soap-client ;; Package-Requires: ((cl-lib "0.6.1")) ;;FIXME: Put in `Package-Requires:' the Emacs version we expect. diff --git a/lisp/net/soap-inspect.el b/lisp/net/soap-inspect.el index 6f9ce6a2d69..2192a687913 100644 --- a/lisp/net/soap-inspect.el +++ b/lisp/net/soap-inspect.el @@ -6,7 +6,7 @@ ;; Created: October 2010 ;; Keywords: soap, web-services, comm, hypermedia ;; Package: soap-client -;; Homepage: https://github.com/alex-hhh/emacs-soap-client +;; URL: https://github.com/alex-hhh/emacs-soap-client ;; This file is part of GNU Emacs. diff --git a/lisp/printing.el b/lisp/printing.el index e7aab901d53..7587676ab27 100644 --- a/lisp/printing.el +++ b/lisp/printing.el @@ -5,7 +5,7 @@ ;; Author: Vinicius Jose Latorre ;; Keywords: wp, print, PostScript ;; Version: 6.9.3 -;; X-URL: https://www.emacswiki.org/cgi-bin/wiki/ViniciusJoseLatorre +;; URL: https://www.emacswiki.org/cgi-bin/wiki/ViniciusJoseLatorre (defconst pr-version "6.9.3" "printing.el, v 6.9.3 <2007/12/09 vinicius> diff --git a/lisp/progmodes/antlr-mode.el b/lisp/progmodes/antlr-mode.el index 2a4b3482831..a74ca1ed239 100644 --- a/lisp/progmodes/antlr-mode.el +++ b/lisp/progmodes/antlr-mode.el @@ -5,7 +5,7 @@ ;; Author: Christoph Wedler ;; Keywords: languages, ANTLR, code generator ;; Version: 2.2c -;; X-URL: http://antlr-mode.sourceforge.net/ +;; URL: http://antlr-mode.sourceforge.net/ ;; This file is part of GNU Emacs. diff --git a/lisp/progmodes/cl-font-lock.el b/lisp/progmodes/cl-font-lock.el index 178fe944f30..f602c3e13f4 100644 --- a/lisp/progmodes/cl-font-lock.el +++ b/lisp/progmodes/cl-font-lock.el @@ -8,7 +8,6 @@ ;; Package-Requires: ((emacs "24.5")) ;; Keywords: lisp wp files convenience ;; URL: https://github.com/cl-font-lock/cl-font-lock -;; Homepage: https://github.com/cl-font-lock/cl-font-lock ;; This file is part of GNU Emacs diff --git a/lisp/progmodes/ebnf2ps.el b/lisp/progmodes/ebnf2ps.el index 052a68547b8..21ab48b1104 100644 --- a/lisp/progmodes/ebnf2ps.el +++ b/lisp/progmodes/ebnf2ps.el @@ -5,7 +5,7 @@ ;; Author: Vinicius Jose Latorre ;; Keywords: wp, ebnf, PostScript ;; Version: 4.4 -;; X-URL: https://www.emacswiki.org/cgi-bin/wiki/ViniciusJoseLatorre +;; URL: https://www.emacswiki.org/cgi-bin/wiki/ViniciusJoseLatorre ;; This file is part of GNU Emacs. diff --git a/lisp/progmodes/gdb-mi.el b/lisp/progmodes/gdb-mi.el index 67ad39b7f46..41384e129b0 100644 --- a/lisp/progmodes/gdb-mi.el +++ b/lisp/progmodes/gdb-mi.el @@ -5,11 +5,10 @@ ;; Author: Nick Roberts ;; Maintainer: emacs-devel@gnu.org ;; Keywords: unix, tools +;; URL: https://www.emacswiki.org/emacs/GDB-MI ;; This file is part of GNU Emacs. -;; Homepage: https://www.emacswiki.org/emacs/GDB-MI - ;; GNU Emacs is free software: you can redistribute it and/or modify ;; it under the terms of the GNU General Public License as published by ;; the Free Software Foundation, either version 3 of the License, or diff --git a/lisp/progmodes/verilog-mode.el b/lisp/progmodes/verilog-mode.el index 5cc834f4a89..fe0e4fb0837 100644 --- a/lisp/progmodes/verilog-mode.el +++ b/lisp/progmodes/verilog-mode.el @@ -4,7 +4,7 @@ ;; Author: Michael McNamara ;; Wilson Snyder -;; X-URL: https://www.veripool.org +;; URL: https://www.veripool.org ;; Created: 3 Jan 1996 ;; Keywords: languages ;; The "Version" is the date followed by the decimal rendition of the Git diff --git a/lisp/ps-def.el b/lisp/ps-def.el index b9c3ab57a26..4f8498d9ef2 100644 --- a/lisp/ps-def.el +++ b/lisp/ps-def.el @@ -5,7 +5,7 @@ ;; Author: Vinicius Jose Latorre ;; Kenichi Handa (multi-byte characters) ;; Keywords: wp, print, PostScript -;; X-URL: https://www.emacswiki.org/cgi-bin/wiki/ViniciusJoseLatorre +;; URL: https://www.emacswiki.org/cgi-bin/wiki/ViniciusJoseLatorre ;; Package: ps-print ;; This file is part of GNU Emacs. diff --git a/lisp/ps-print.el b/lisp/ps-print.el index 1b8654ead2b..c5a48f59aa5 100644 --- a/lisp/ps-print.el +++ b/lisp/ps-print.el @@ -9,7 +9,7 @@ ;; Maintainer: Vinicius Jose Latorre ;; Keywords: wp, print, PostScript ;; Version: 7.3.5 -;; X-URL: https://www.emacswiki.org/cgi-bin/wiki/ViniciusJoseLatorre +;; URL: https://www.emacswiki.org/cgi-bin/wiki/ViniciusJoseLatorre (eval-when-compile (require 'cl-lib)) diff --git a/lisp/ps-samp.el b/lisp/ps-samp.el index 22a29b8b4b1..2f7de40da63 100644 --- a/lisp/ps-samp.el +++ b/lisp/ps-samp.el @@ -8,7 +8,7 @@ ;; Kenichi Handa (multi-byte characters) ;; Maintainer: Vinicius Jose Latorre ;; Keywords: wp, print, PostScript -;; X-URL: https://www.emacswiki.org/cgi-bin/wiki/ViniciusJoseLatorre +;; URL: https://www.emacswiki.org/cgi-bin/wiki/ViniciusJoseLatorre ;; Package: ps-print ;; This file is part of GNU Emacs. diff --git a/lisp/whitespace.el b/lisp/whitespace.el index a3a127474d3..7e090177eb7 100644 --- a/lisp/whitespace.el +++ b/lisp/whitespace.el @@ -5,7 +5,7 @@ ;; Author: Vinicius Jose Latorre ;; Keywords: data, wp ;; Version: 13.2.2 -;; X-URL: https://www.emacswiki.org/cgi-bin/wiki/ViniciusJoseLatorre +;; URL: https://www.emacswiki.org/cgi-bin/wiki/ViniciusJoseLatorre ;; This file is part of GNU Emacs. diff --git a/lisp/widget.el b/lisp/widget.el index d258e6fae2b..b72f548f508 100644 --- a/lisp/widget.el +++ b/lisp/widget.el @@ -4,7 +4,7 @@ ;; ;; Author: Per Abrahamsen ;; Keywords: help, extensions, faces, hypermedia -;; X-URL: http://www.dina.kvl.dk/~abraham/custom/ +;; URL: http://www.dina.kvl.dk/~abraham/custom/ ;; Package: emacs ;; This file is part of GNU Emacs. -- cgit v1.2.3 From 63f419f1339cbd0a7d1e64586854a4f01b3f80d1 Mon Sep 17 00:00:00 2001 From: Stefan Kangas Date: Tue, 14 Sep 2021 08:43:18 +0200 Subject: ; Minor stylistic fixes found by checkdoc --- etc/themes/manoj-dark-theme.el | 12 +-- etc/themes/tango-dark-theme.el | 2 +- etc/themes/tango-theme.el | 2 +- lisp/align.el | 2 +- lisp/allout-widgets.el | 18 ++-- lisp/allout.el | 37 ++++----- lisp/ansi-color.el | 2 +- lisp/apropos.el | 2 +- lisp/arc-mode.el | 2 +- lisp/auth-source.el | 19 ++--- lisp/autorevert.el | 10 +-- lisp/bindings.el | 12 +-- lisp/bookmark.el | 2 +- lisp/calc/calc-aent.el | 2 +- lisp/calc/calc-bin.el | 2 +- lisp/calc/calc-ext.el | 2 +- lisp/calc/calc-map.el | 2 +- lisp/calc/calc-menu.el | 2 + lisp/calc/calc-misc.el | 3 +- lisp/calc/calc-units.el | 2 +- lisp/calc/calc.el | 57 ++++++------- lisp/calculator.el | 3 +- lisp/calendar/cal-tex.el | 2 +- lisp/calendar/icalendar.el | 2 +- lisp/calendar/todo-mode.el | 4 +- lisp/cedet/ede/auto.el | 4 +- lisp/cedet/ede/cpp-root.el | 2 +- lisp/cedet/ede/makefile-edit.el | 2 +- lisp/cedet/ede/proj-elisp.el | 4 +- lisp/cedet/ede/proj.el | 2 +- lisp/cedet/ede/project-am.el | 6 +- lisp/cedet/ede/source.el | 4 +- lisp/cedet/mode-local.el | 4 +- lisp/cedet/semantic.el | 2 +- lisp/cedet/semantic/analyze/complete.el | 2 +- lisp/cedet/semantic/bovine/c.el | 6 +- lisp/cedet/semantic/bovine/debug.el | 2 +- lisp/cedet/semantic/complete.el | 2 +- lisp/cedet/semantic/db-el.el | 2 +- lisp/cedet/semantic/db-find.el | 2 +- lisp/cedet/semantic/db-typecache.el | 3 +- lisp/cedet/semantic/debug.el | 8 +- lisp/cedet/semantic/decorate/include.el | 8 +- lisp/cedet/semantic/ede-grammar.el | 2 +- lisp/cedet/semantic/fw.el | 2 +- lisp/cedet/semantic/grammar.el | 2 +- lisp/cedet/semantic/idle.el | 2 +- lisp/cedet/semantic/symref/grep.el | 2 +- lisp/cedet/semantic/symref/list.el | 2 +- lisp/cedet/semantic/tag.el | 13 ++- lisp/cedet/semantic/util-modes.el | 4 +- lisp/cedet/srecode/ctxt.el | 2 +- lisp/cedet/srecode/dictionary.el | 2 +- lisp/cedet/srecode/semantic.el | 2 +- lisp/cmuscheme.el | 8 +- lisp/comint.el | 2 +- lisp/completion.el | 4 +- lisp/composite.el | 2 +- lisp/delim-col.el | 2 +- lisp/descr-text.el | 2 +- lisp/dired-aux.el | 6 +- lisp/dired.el | 26 +++--- lisp/doc-view.el | 8 +- lisp/dos-fns.el | 4 +- lisp/edmacro.el | 2 +- lisp/elec-pair.el | 4 +- lisp/emacs-lisp/byte-run.el | 6 +- lisp/emulation/cua-base.el | 10 +-- lisp/emulation/edt-mapper.el | 6 +- lisp/emulation/keypad.el | 4 +- lisp/emulation/viper-cmd.el | 12 +-- lisp/emulation/viper-ex.el | 2 +- lisp/emulation/viper-keym.el | 8 +- lisp/emulation/viper-mous.el | 2 +- lisp/emulation/viper.el | 4 +- lisp/epa-hook.el | 2 +- lisp/epa.el | 2 +- lisp/erc/erc-autoaway.el | 2 +- lisp/erc/erc-button.el | 4 +- lisp/erc/erc-ibuffer.el | 9 +- lisp/erc/erc-match.el | 2 +- lisp/erc/erc-netsplit.el | 5 +- lisp/erc/erc-networks.el | 4 +- lisp/erc/erc-pcomplete.el | 2 +- lisp/erc/erc-replace.el | 2 +- lisp/erc/erc-ring.el | 2 +- lisp/erc/erc-sound.el | 5 +- lisp/erc/erc-spelling.el | 2 +- lisp/erc/erc-status-sidebar.el | 2 +- lisp/erc/erc-track.el | 12 +-- lisp/erc/erc-truncate.el | 6 +- lisp/erc/erc-xdcc.el | 2 +- lisp/erc/erc.el | 92 +++++++++++---------- lisp/eshell/esh-io.el | 2 +- lisp/expand.el | 2 +- lisp/face-remap.el | 11 +-- lisp/ffap.el | 4 +- lisp/filenotify.el | 2 +- lisp/files.el | 4 +- lisp/filesets.el | 2 +- lisp/find-file.el | 16 ++-- lisp/find-lisp.el | 6 +- lisp/font-lock.el | 10 +-- lisp/forms.el | 18 ++-- lisp/gnus/gnus-agent.el | 21 ++--- lisp/gnus/gnus-art.el | 19 ++--- lisp/gnus/gnus-diary.el | 6 +- lisp/gnus/gnus-dired.el | 2 +- lisp/gnus/gnus-icalendar.el | 8 +- lisp/gnus/gnus-int.el | 3 +- lisp/gnus/gnus-ml.el | 2 +- lisp/gnus/gnus-mlspl.el | 2 +- lisp/gnus/gnus-msg.el | 2 +- lisp/gnus/gnus-registry.el | 4 +- lisp/gnus/gnus-salt.el | 2 +- lisp/gnus/gnus-score.el | 2 +- lisp/gnus/gnus-search.el | 26 +++--- lisp/gnus/gnus-sieve.el | 5 +- lisp/gnus/gnus-srvr.el | 2 +- lisp/gnus/gnus-start.el | 6 +- lisp/gnus/gnus-sum.el | 10 +-- lisp/gnus/gnus-util.el | 8 +- lisp/gnus/gnus-uu.el | 38 ++++----- lisp/gnus/gnus.el | 2 +- lisp/help-fns.el | 6 +- lisp/help-mode.el | 2 +- lisp/hexl.el | 2 +- lisp/hippie-exp.el | 2 +- lisp/ibuf-ext.el | 4 +- lisp/icomplete.el | 2 +- lisp/ido.el | 8 +- lisp/iimage.el | 2 +- lisp/image-mode.el | 4 +- lisp/image.el | 2 +- lisp/informat.el | 2 +- lisp/international/characters.el | 2 +- lisp/international/iso-cvt.el | 4 +- lisp/international/latexenc.el | 4 +- lisp/international/mule.el | 2 +- lisp/international/quail.el | 2 +- lisp/jsonrpc.el | 4 +- lisp/kermit.el | 2 +- lisp/kmacro.el | 6 +- lisp/language/ind-util.el | 12 +-- lisp/language/thai-word.el | 13 +-- lisp/language/tibet-util.el | 12 +-- lisp/language/tv-util.el | 10 +-- lisp/leim/quail/sami.el | 2 +- lisp/leim/quail/vnvni.el | 2 + lisp/loadup.el | 2 +- lisp/locate.el | 14 ++-- lisp/ls-lisp.el | 2 +- lisp/macros.el | 2 +- lisp/mail/blessmail.el | 2 +- lisp/mail/feedmail.el | 12 +-- lisp/mail/footnote.el | 18 ++-- lisp/mail/mailabbrev.el | 12 +-- lisp/mail/mailclient.el | 2 +- lisp/mail/mspools.el | 4 +- lisp/mail/reporter.el | 4 +- lisp/mail/rmail-spam-filter.el | 2 + lisp/mail/rmail.el | 5 +- lisp/mail/rmailout.el | 2 +- lisp/mail/supercite.el | 2 +- lisp/menu-bar.el | 2 +- lisp/midnight.el | 2 +- lisp/minibuf-eldef.el | 2 +- lisp/mouse-copy.el | 4 +- lisp/mpc.el | 8 +- lisp/net/ange-ftp.el | 132 +++++++++++++++--------------- lisp/net/browse-url.el | 4 +- lisp/net/dictionary.el | 12 +-- lisp/net/eudc.el | 2 +- lisp/net/eww.el | 2 +- lisp/net/gnutls.el | 2 +- lisp/net/goto-addr.el | 2 +- lisp/net/ldap.el | 3 +- lisp/net/mailcap.el | 4 +- lisp/net/nsm.el | 8 +- lisp/net/quickurl.el | 16 ++-- lisp/net/sasl-cram.el | 2 + lisp/net/sasl-digest.el | 4 +- lisp/net/secrets.el | 2 +- lisp/net/shr-color.el | 2 +- lisp/net/shr.el | 2 +- lisp/net/sieve-manage.el | 2 +- lisp/net/sieve-mode.el | 2 +- lisp/net/sieve.el | 2 +- lisp/net/snmp-mode.el | 4 +- lisp/net/socks.el | 2 +- lisp/net/telnet.el | 5 +- lisp/net/tramp-sh.el | 4 +- lisp/net/tramp.el | 2 +- lisp/net/zeroconf.el | 6 +- lisp/newcomment.el | 10 +-- lisp/notifications.el | 2 +- lisp/nxml/nxml-mode.el | 15 ++-- lisp/nxml/nxml-ns.el | 2 +- lisp/nxml/nxml-outln.el | 10 +-- lisp/nxml/nxml-rap.el | 16 ++-- lisp/nxml/rng-nxml.el | 2 +- lisp/nxml/rng-valid.el | 18 ++-- lisp/nxml/rng-xsd.el | 2 +- lisp/nxml/xmltok.el | 8 +- lisp/pixel-scroll.el | 6 +- lisp/play/5x5.el | 7 +- lisp/play/cookie1.el | 6 +- lisp/play/decipher.el | 2 +- lisp/play/dunnet.el | 2 +- lisp/play/fortune.el | 2 +- lisp/play/gamegrid.el | 2 +- lisp/play/gametree.el | 2 +- lisp/play/handwrite.el | 2 +- lisp/play/hanoi.el | 6 +- lisp/play/life.el | 4 +- lisp/play/mpuz.el | 2 +- lisp/play/spook.el | 2 +- lisp/play/zone.el | 2 +- lisp/plstore.el | 2 +- lisp/printing.el | 16 ++-- lisp/proced.el | 6 +- lisp/profiler.el | 17 ++-- lisp/progmodes/cc-align.el | 8 +- lisp/progmodes/cc-awk.el | 7 +- lisp/progmodes/cc-bytecomp.el | 2 +- lisp/progmodes/cc-cmds.el | 8 +- lisp/progmodes/cc-defs.el | 4 +- lisp/progmodes/cc-engine.el | 12 +-- lisp/progmodes/cc-guess.el | 20 ++--- lisp/progmodes/cc-langs.el | 12 +-- lisp/progmodes/cc-menus.el | 2 +- lisp/progmodes/cc-mode.el | 53 ++++++------ lisp/progmodes/cc-styles.el | 2 +- lisp/progmodes/cc-vars.el | 40 ++++----- lisp/progmodes/cperl-mode.el | 17 ++-- lisp/progmodes/ebnf-dtd.el | 8 +- lisp/progmodes/ebnf-ebx.el | 2 +- lisp/progmodes/elisp-mode.el | 4 +- lisp/progmodes/etags.el | 2 +- lisp/progmodes/f90.el | 19 +++-- lisp/progmodes/flymake-cc.el | 2 +- lisp/progmodes/flymake-proc.el | 14 ++-- lisp/progmodes/flymake.el | 2 +- lisp/progmodes/fortran.el | 2 +- lisp/progmodes/gdb-mi.el | 2 +- lisp/progmodes/grep.el | 2 +- lisp/progmodes/gud.el | 10 +-- lisp/progmodes/hideif.el | 2 +- lisp/progmodes/idlw-complete-structtag.el | 4 +- lisp/progmodes/idlw-help.el | 5 +- lisp/progmodes/idlw-shell.el | 46 +++++------ lisp/progmodes/idlw-toolbar.el | 2 +- lisp/progmodes/idlwave.el | 14 ++-- lisp/progmodes/js.el | 16 ++-- lisp/progmodes/ld-script.el | 4 +- lisp/progmodes/octave.el | 4 +- lisp/progmodes/opascal.el | 13 +-- lisp/progmodes/perl-mode.el | 12 +-- lisp/progmodes/prolog.el | 14 ++-- lisp/progmodes/ps-mode.el | 2 +- lisp/progmodes/python.el | 21 +++-- lisp/progmodes/ruby-mode.el | 8 +- lisp/progmodes/sql.el | 4 +- lisp/progmodes/tcl.el | 2 +- lisp/progmodes/verilog-mode.el | 29 ++++--- lisp/progmodes/vhdl-mode.el | 69 ++++++++-------- lisp/progmodes/xref.el | 14 ++-- lisp/ps-print.el | 12 +-- lisp/register.el | 2 +- lisp/registry.el | 4 +- lisp/replace.el | 4 +- lisp/rfn-eshadow.el | 2 +- lisp/rtree.el | 2 +- lisp/saveplace.el | 2 +- lisp/server.el | 2 +- lisp/ses.el | 37 +++++---- lisp/simple.el | 6 +- lisp/so-long.el | 14 ++-- lisp/sort.el | 4 +- lisp/subr.el | 10 +-- lisp/t-mouse.el | 2 +- lisp/tab-bar.el | 4 +- lisp/tar-mode.el | 8 +- lisp/tempo.el | 32 ++++---- lisp/term.el | 2 +- lisp/term/ns-win.el | 4 +- lisp/term/sun.el | 4 +- lisp/term/x-win.el | 2 +- lisp/term/xterm.el | 7 +- lisp/textmodes/artist.el | 2 +- lisp/textmodes/bibtex.el | 4 +- lisp/textmodes/conf-mode.el | 2 +- lisp/textmodes/fill.el | 2 +- lisp/textmodes/ispell.el | 2 +- lisp/textmodes/picture.el | 8 +- lisp/textmodes/reftex-cite.el | 2 +- lisp/textmodes/reftex-index.el | 2 +- lisp/textmodes/reftex.el | 2 +- lisp/textmodes/table.el | 16 ++-- lisp/textmodes/texinfmt.el | 10 +-- lisp/thingatpt.el | 2 +- lisp/time.el | 4 +- lisp/transient.el | 16 ++-- lisp/url/url-http.el | 4 +- lisp/url/url-imap.el | 4 +- lisp/url/url-util.el | 2 +- lisp/url/url-vars.el | 3 +- lisp/vc/ediff-init.el | 6 +- lisp/vc/ediff-vers.el | 4 +- lisp/vc/emerge.el | 4 +- lisp/vc/vc-cvs.el | 2 +- lisp/vc/vc-dav.el | 9 +- lisp/vc/vc-dir.el | 2 +- lisp/vt-control.el | 2 +- lisp/wdired.el | 2 +- lisp/widget.el | 2 +- lisp/windmove.el | 4 +- lisp/window.el | 10 +-- lisp/winner.el | 3 +- lisp/xdg.el | 4 +- lisp/xml.el | 2 +- lisp/xt-mouse.el | 8 +- test/lisp/abbrev-tests.el | 22 ++--- test/lisp/arc-mode-tests.el | 2 +- test/lisp/auth-source-tests.el | 2 +- test/manual/cedet/semantic-tests.el | 4 +- 326 files changed, 1158 insertions(+), 1180 deletions(-) (limited to 'lisp/progmodes/gdb-mi.el') diff --git a/etc/themes/manoj-dark-theme.el b/etc/themes/manoj-dark-theme.el index e3df40ebe92..0e5fb391198 100644 --- a/etc/themes/manoj-dark-theme.el +++ b/etc/themes/manoj-dark-theme.el @@ -23,11 +23,11 @@ ;;; Commentary: ;; I spend a lot of time working in front of a screen (many hours in a -;; dimly lit room) and eye fatigue is an issue. This is a dark color -;; theme for emacs, which is easier on the eyes than light themes. +;; dimly lit room) and eye fatigue is an issue. This is a dark color +;; theme for Emacs, which is easier on the eyes than light themes. ;; It does not help that I am blue-green color blind, so subtle -;; variations are often lost on me. I do want to use color contrast to +;; variations are often lost on me. I do want to use color contrast to ;; increase productivity, but I also want to avoid the jarring angry ;; fruit salad look, and so I am in the process of crafting a logical ;; color scheme that is high contrast enough for me, without being too @@ -35,7 +35,7 @@ ;; In circumstances where there a lot of related faces that can be ;; viewed, for example, the Gnus group buffer, consistent and logical -;; color choices are the only sane option. Gnus groups can be newa +;; color choices are the only sane option. Gnus groups can be newa ;; (blueish) or mail (greenish), have states (large number of under ;; messages, normal, and empty). The large number unread groups have ;; highest luminance (appear brighter), and the empty one have lower @@ -45,8 +45,8 @@ ;; constant separation -- so all the related groups have the same ;; brightness ({mail,news}/{unread,normal,empty}), and a graded ;; selection of foreground colors. It sounds more complicated that it -;; looks. The eye is drawn naturally to the unread groups, and first -;; to the mail, then USENET groups (which is my preference). +;; looks. The eye is drawn naturally to the unread groups, and first +;; to the mail, then Usenet groups (which is my preference). ;; Similar color variations occur for individual messages in a group; ;; high scoring messages bubble to the top, and have a higher diff --git a/etc/themes/tango-dark-theme.el b/etc/themes/tango-dark-theme.el index a8577108ed3..1a33676eba7 100644 --- a/etc/themes/tango-dark-theme.el +++ b/etc/themes/tango-dark-theme.el @@ -20,7 +20,7 @@ ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs. If not, see . -;;; Commentary +;;; Commentary: ;; The colors in this theme come from the Tango palette, which is in ;; the public domain: http://tango.freedesktop.org/ diff --git a/etc/themes/tango-theme.el b/etc/themes/tango-theme.el index 286561eb4e2..9ee2619ce24 100644 --- a/etc/themes/tango-theme.el +++ b/etc/themes/tango-theme.el @@ -20,7 +20,7 @@ ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs. If not, see . -;;; Commentary +;;; Commentary: ;; The colors in this theme come from the Tango palette, which is in ;; the public domain: http://tango.freedesktop.org/ diff --git a/lisp/align.el b/lisp/align.el index a0b626a5c43..2f380a80774 100644 --- a/lisp/align.el +++ b/lisp/align.el @@ -787,7 +787,7 @@ See the variable `align-exclude-rules-list' for more details.") "The current overlays highlighting the text matched by a rule.") (defvar align-regexp-history nil - "Input history for the full user-entered regex in `align-regexp'") + "Input history for the full user-entered regex in `align-regexp'.") ;; Sample extension rule set for vhdl-mode. This is now obsolete. (defcustom align-vhdl-rules-list diff --git a/lisp/allout-widgets.el b/lisp/allout-widgets.el index 0e127040886..668e7b91e86 100644 --- a/lisp/allout-widgets.el +++ b/lisp/allout-widgets.el @@ -32,7 +32,7 @@ ;; invoke allout-widgets-mode in a particular allout buffer. When ;; auto-enabled, you can inhibit widget operation in particular allout ;; buffers by setting the variable `allout-widgets-mode-inhibit' non-nil in -;; that file's buffer. Use emacs *file local variables* to generally +;; that file's buffer. Use Emacs *file local variables* to generally ;; inhibit for a file. ;; ;; See the `allout-widgets-mode' docstring for more details. @@ -55,7 +55,7 @@ ;; bindings for easy outline navigation and exposure control, extending ;; outline hot-spot navigation (see `allout-mode' docstring for details). ;; -;; Developers note: Our use of emacs widgets is unconventional. We +;; Developers note: Our use of Emacs widgets is unconventional. We ;; decorate existing text rather than substituting for it, to ;; piggy-back on existing allout operation. This employs the C-coded ;; efficiencies of widget-apply, widget-get, and widget-put, along @@ -87,7 +87,7 @@ "Allout extension that highlights outline structure graphically. Customize `allout-widgets-auto-activation' to activate allout-widgets -with allout-mode." +with `allout-mode'." :group 'allout) ;;;_ > defgroup allout-widgets-developer (defgroup allout-widgets-developer nil @@ -96,19 +96,19 @@ with allout-mode." ;;;_ ; some functions a bit early, for allout-auto-activation dependency: ;;;_ > allout-widgets-mode-enable (defun allout-widgets-mode-enable () - "Enable allout-widgets-mode in allout-mode buffers. + "Enable `allout-widgets-mode' in `allout-mode' buffers. See `allout-widgets-mode-inhibit' for per-file/per-buffer -inhibition of allout-widgets-mode." +inhibition of `allout-widgets-mode'." (add-hook 'allout-mode-off-hook #'allout-widgets-mode-off) (add-hook 'allout-mode-on-hook #'allout-widgets-mode-on) t) ;;;_ > allout-widgets-mode-disable (defun allout-widgets-mode-disable () - "Disable allout-widgets-mode in allout-mode buffers. + "Disable `allout-widgets-mode' in `allout-mode' buffers. See `allout-widgets-mode-inhibit' for per-file/per-buffer -inhibition of allout-widgets-mode." +inhibition of `allout-widgets-mode'." (remove-hook 'allout-mode-off-hook #'allout-widgets-mode-off) (remove-hook 'allout-mode-on-hook #'allout-widgets-mode-on) t) @@ -384,7 +384,7 @@ onto the front.") ) ;;;_ = allout-doing-exposure-undo-processor nil (defvar allout-undo-exposure-in-progress nil - "Maintained true during `allout-widgets-exposure-undo-processor'") + "Maintained true during `allout-widgets-exposure-undo-processor'.") ;;;_ , Widget-specific outline text format ;;;_ = allout-escaped-prefix-regexp (defvar-local allout-escaped-prefix-regexp "" @@ -1450,7 +1450,7 @@ recursive operation." ) ;;;_ > allout-new-item-widget () (defsubst allout-new-item-widget () - "create a new item widget, not yet situated anywhere." + "Create a new item widget, not yet situated anywhere." (if allout-widgets-maintain-tally ;; all the extra overhead is incurred only when doing the ;; maintenance, except the condition, which can't be avoided. diff --git a/lisp/allout.el b/lisp/allout.el index 622596310b2..09977aae843 100644 --- a/lisp/allout.el +++ b/lisp/allout.el @@ -26,7 +26,7 @@ ;;; Commentary: ;; Allout outline minor mode provides extensive outline formatting and -;; and manipulation beyond standard emacs outline mode. Some features: +;; and manipulation beyond standard Emacs outline mode. Some features: ;; ;; - Classic outline-mode topic-oriented navigation and exposure adjustment ;; - Topic-oriented editing including coherent topic and subtopic @@ -35,7 +35,7 @@ ;; - Customizable bullet format -- enables programming-language specific ;; outlining, for code-folding editing. (Allout code itself is to try it; ;; formatted as an outline -- do ESC-x eval-buffer in allout.el; but -;; emacs local file variables need to be enabled when the +;; Emacs local file variables need to be enabled when the ;; file was visited -- see `enable-local-variables'.) ;; - Configurable per-file initial exposure settings ;; - Symmetric-key and key-pair topic encryption. Encryption is via the @@ -242,7 +242,7 @@ prevails." ) "Allout-mode functions bound to keys without any added prefix. -This is in contrast to the majority of allout-mode bindings on +This is in contrast to the majority of `allout-mode' bindings on `allout-prefixed-keybindings', whose bindings are created with a preceding command key. @@ -288,7 +288,7 @@ Control whether and how allout outline mode is automatically activated when files are visited with non-nil buffer-specific file variable `allout-layout'. -When allout-auto-activation is \"On\" (t), allout mode is +When `allout-auto-activation' is \"On\" (t), allout mode is activated in buffers with non-nil `allout-layout', and the specified layout is applied. @@ -382,7 +382,7 @@ in individual buffers if you want to inhibit auto-fill only in particular buffers. (You could use a function on `allout-mode-hook' to inhibit auto-fill according, eg, to the major mode.) -If you don't set this and auto-fill-mode is enabled, allout will use the +If you don't set this and `auto-fill-mode' is enabled, allout will use the value that `normal-auto-fill-function', if any, when allout mode starts, or else allout's special hanging-indent maintaining auto-fill function, `allout-auto-fill'." @@ -460,7 +460,7 @@ advance as follows: - if the cursor is on the first column of the headline: then it goes to the start of the headline within the item body. -In this fashion, you can use the beginning-of-line command to do +In this fashion, you can use the `beginning-of-line' command to do its normal job and then, when repeated, advance through the entry, cycling back to start. @@ -882,7 +882,7 @@ has been customized to enable this behavior), `allout-mode' will be automatically activated. The layout dictated by the value will be used to set the initial exposure when `allout-mode' is activated. -*You should not setq-default this variable non-nil unless you want every +*You should not `setq-default' this variable non-nil unless you want every visited file to be treated as an allout file.* The value would typically be set by a file local variable. For @@ -1321,21 +1321,21 @@ The settings are stored on `allout-mode-prior-settings'." (if qualifier (cond ((eq qualifier 'extend) (if (not (listp prior-value)) - (error "extension of non-list prior value attempted") + (error "Extension of non-list prior value attempted") (set name (cons value prior-value)))) ((eq qualifier 'append) (if (not (listp prior-value)) - (error "appending of non-list prior value attempted") + (error "Appending of non-list prior value attempted") (set name (append prior-value (list value))))) - (t (error "unrecognized setting qualifier `%s' encountered" + (t (error "Unrecognized setting qualifier `%s' encountered" qualifier))) (set name value))))) ;;;_ > allout-do-resumptions () (defun allout-do-resumptions () "Resume all name/value settings registered by `allout-add-resumptions'. -This is used when concluding allout-mode, to resume selected variables to -their settings before allout-mode was started." +This is used when concluding `allout-mode', to resume selected variables to +their settings before `allout-mode' was started." (while allout-mode-prior-settings (let* ((pair (pop allout-mode-prior-settings)) @@ -2129,7 +2129,7 @@ to return the current depth." allout-recent-depth) ;;;_ > allout-recent-prefix () (defsubst allout-recent-prefix () - "Like `allout-recent-depth', but returns text of last encountered prefix. + "Like `allout-recent-depth', but return text of last encountered prefix. All outline functions which directly do string matches to assess headings set the variables `allout-recent-prefix-beginning' and @@ -2139,7 +2139,7 @@ to return the current prefix." allout-recent-prefix-end)) ;;;_ > allout-recent-bullet () (defmacro allout-recent-bullet () - "Like `allout-recent-prefix', but returns bullet of last encountered prefix. + "Like `allout-recent-prefix', but return bullet of last encountered prefix. All outline functions which directly do string matches to assess headings set the variables `allout-recent-prefix-beginning' and @@ -3145,7 +3145,7 @@ Returns resulting position, else nil if none found." (start-arg arg) (backward (> 0 arg))) (if (= 0 start-depth) - (error "No siblings, not in a topic...")) + (error "No siblings, not in a topic")) (if backward (setq arg (* -1 arg))) (allout-back-to-current-heading) (while (and (not (zerop arg)) @@ -3185,7 +3185,7 @@ are mapped to the command of the corresponding control-key on the `allout-mode-map-value'.") ;;;_ = allout-command-counter (defvar-local allout-command-counter 0 - "Counter that monotonically increases in allout-mode buffers. + "Counter that monotonically increases in `allout-mode' buffers. Set by `allout-pre-command-business', to support allout addons in coordinating with allout activity.") @@ -3325,7 +3325,6 @@ See `allout-auto-activation' for setup instructions." ;;;_ - Topic Format Assessment ;;;_ > allout-solicit-alternate-bullet (depth &optional current-bullet) (defun allout-solicit-alternate-bullet (depth &optional current-bullet) - "Prompt for and return a bullet char as an alternative to the current one. Offer one suitable for current depth DEPTH as default." @@ -5807,7 +5806,7 @@ See `allout-toggle-current-subtree-encryption' for more details." (after-bullet-pos (point)) (was-encrypted (progn (if (= (point-max) after-bullet-pos) - (error "no body to encrypt")) + (error "No body to encrypt")) (allout-encrypted-topic-p))) (was-collapsed (if (not (search-forward "\n" nil t)) nil @@ -6032,7 +6031,7 @@ signal." ;; validate result -- non-empty (if (not result-text) - (error "%scryption failed." (if decrypt "De" "En"))) + (error "%scryption failed" (if decrypt "De" "En"))) (when (eq keypair-mode 'prompt-save) diff --git a/lisp/ansi-color.el b/lisp/ansi-color.el index 79dc821ea19..79b1c9912f5 100644 --- a/lisp/ansi-color.el +++ b/lisp/ansi-color.el @@ -43,7 +43,7 @@ ;; The "Graphic Rendition Combination Mode (GRCM)" implemented is ;; "cumulative mode" as defined in section 7.2.8. Cumulative mode ;; means that whenever possible, SGR control sequences are combined -;; (ie. blue and bold). +;; (i.e. blue and bold). ;; The basic functions are: ;; diff --git a/lisp/apropos.el b/lisp/apropos.el index a1470537d9a..513175d7513 100644 --- a/lisp/apropos.el +++ b/lisp/apropos.el @@ -78,7 +78,7 @@ This option only controls the default behavior. Each of the above commands also has an optional argument to request a more extensive search. Additionally, this option makes the function `apropos-library' -include key-binding information in its output." +include keybinding information in its output." :type 'boolean) (defface apropos-symbol diff --git a/lisp/arc-mode.el b/lisp/arc-mode.el index 71ad7bd0c5d..5576ae35053 100644 --- a/lisp/arc-mode.el +++ b/lisp/arc-mode.el @@ -1759,7 +1759,7 @@ This doesn't recover lost files, it just undoes changes in the buffer itself." neh ;beginning of next extension header (level 1 and 2) mode uid gid dir prname gname uname modtime moddate) - (if (= hdrlvl 3) (error "can't handle lzh level 3 header type")) + (if (= hdrlvl 3) (error "Can't handle lzh level 3 header type")) (when (or (= hdrlvl 0) (= hdrlvl 1)) (setq fnlen (get-byte (+ p 21))) ;filename length (setq efnname (let ((str (buffer-substring (+ p 22) (+ p 22 fnlen)))) ;filename from offset 22 diff --git a/lisp/auth-source.el b/lisp/auth-source.el index 69197383982..8d6ebd39dcb 100644 --- a/lisp/auth-source.el +++ b/lisp/auth-source.el @@ -79,9 +79,8 @@ ;;;###autoload (defcustom auth-source-cache-expiry 7200 - "How many seconds passwords are cached, or nil to disable -expiring. Overrides `password-cache-expiry' through a -let-binding." + "How many seconds passwords are cached, or nil to disable expiring. +Overrides `password-cache-expiry' through a let-binding." :version "24.1" :type '(choice (const :tag "Never" nil) (const :tag "All Day" 86400) @@ -353,7 +352,7 @@ backend starts with the first element on the list and stops as soon as a function returns non-nil.") (defun auth-source-backend-parse (entry) - "Create an auth-source-backend from an ENTRY in `auth-sources'." + "Create an `auth-source-backend' from an ENTRY in `auth-sources'." (let ((backend (run-hook-with-args-until-success 'auth-source-backend-parser-functions @@ -823,7 +822,7 @@ Returns t or nil for forgotten or not found." (password-cache-remove (auth-source-format-cache-entry spec))) (defun auth-source-forget+ (&rest spec) - "Forget any cached data matching SPEC. Returns forgotten count. + "Forget any cached data matching SPEC. Return forgotten count. This is not a full `auth-source-search' spec but works similarly. For instance, \(:host \"myhost\" \"yourhost\") would find all the @@ -1198,7 +1197,7 @@ FILE is the file from which we obtained this token." (mapcar #'1- string))) (defun auth-source--pad (string length) - "Pad string S to a modulo of LENGTH." + "Pad STRING to a modulo of LENGTH." (let ((pad (- length (mod (length string) length)))) (concat string (make-string pad pad)))) @@ -1573,8 +1572,7 @@ collection that's a Google Chrome entry for the git.gnus.org site authentication tokens: (let ((auth-sources \\='(\"secrets:Login\"))) - (auth-source-search :max 1 :signon_realm \"https://git.gnus.org/Git\")) -" + (auth-source-search :max 1 :signon_realm \"https://git.gnus.org/Git\"))" ;; TODO ;; (secrets-delete-item coll elt) @@ -1875,8 +1873,7 @@ And this one looks for the first item in the internet keychain entries for git.gnus.org: (let ((auth-sources \\='(macos-keychain-internet\"))) - (auth-source-search :max 1 :host \"git.gnus.org\")) -" + (auth-source-search :max 1 :host \"git.gnus.org\"))" ;; TODO (cl-assert (not create) nil "The macOS Keychain auth-source backend doesn't support creation yet") @@ -1941,7 +1938,7 @@ entries for git.gnus.org: (defun auth-source--decode-octal-string (string) - "Convert octal string to utf-8 string. E.g: 'a\134b' to 'a\b'" + "Convert octal STRING to utf-8 string. E.g: 'a\134b' to 'a\b'." (let ((list (string-to-list string)) (size (length string))) (decode-coding-string diff --git a/lisp/autorevert.el b/lisp/autorevert.el index 9197eadf225..c8fe205946c 100644 --- a/lisp/autorevert.el +++ b/lisp/autorevert.el @@ -36,7 +36,7 @@ ;; buffer contains no unsaved changes. ;; ;; Auto-Revert Mode can be activated for individual buffers. Global -;; Auto-Revert Mode applies to all file buffers. (If the user option +;; Auto-Revert Mode applies to all file buffers. (If the user option ;; `global-auto-revert-non-file-buffers' is non-nil, it also applies ;; to some non-file buffers. This option is disabled by default.) ;; @@ -72,7 +72,7 @@ ;; at the end of the buffer in that window, even if the window is not ;; selected. This way, you can use Auto-Revert Mode to `tail' a file. ;; Just put point at the end of the buffer and it will stay there. -;; These rules apply to file buffers. For non-file buffers, the +;; These rules apply to file buffers. For non-file buffers, the ;; behavior may be mode dependent. ;; ;; While you can use Auto-Revert Mode to tail a file, this package @@ -853,8 +853,8 @@ This is an internal function used by Auto-Revert Mode." "Return a prioritized list of buffers to maybe auto-revert. The differences between this return value and the reference variable `auto-revert-buffer-list' include: 1) this has more -entries when in global-auto-revert-mode; 2) this prioritizes -buffers not reverted last time due to user interruption. " +entries when in `global-auto-revert-mode'; 2) this prioritizes +buffers not reverted last time due to user interruption." (let ((bufs (delq nil ;; Buffers with remote contents shall be reverted only ;; if the connection is established already. @@ -881,7 +881,7 @@ buffers not reverted last time due to user interruption. " (nreverse (nconc new remaining)))) (defun auto-revert-buffer (buf) - "Revert a single buffer. + "Revert a single buffer BUF. This is performed as specified by Auto-Revert and Global Auto-Revert Modes." diff --git a/lisp/bindings.el b/lisp/bindings.el index b8bf0c1a6f6..4dfc9a908cf 100644 --- a/lisp/bindings.el +++ b/lisp/bindings.el @@ -614,20 +614,20 @@ By default, this shows the information specified by `global-mode-string'.") (list `(quote ,standard-mode-line-format)))) -(defun mode-line-unbury-buffer (event) "\ -Call `unbury-buffer' in this window." +(defun mode-line-unbury-buffer (event) + "Call `unbury-buffer' in this window." (interactive "e") (with-selected-window (posn-window (event-start event)) (unbury-buffer))) -(defun mode-line-bury-buffer (event) "\ -Like `bury-buffer', but temporarily select EVENT's window." +(defun mode-line-bury-buffer (event) + "Like `bury-buffer', but temporarily select EVENT's window." (interactive "e") (with-selected-window (posn-window (event-start event)) (bury-buffer))) -(defun mode-line-other-buffer () "\ -Switch to the most recently selected buffer other than the current one." +(defun mode-line-other-buffer () + "Switch to the most recently selected buffer other than the current one." (interactive) (switch-to-buffer (other-buffer) nil t)) diff --git a/lisp/bookmark.el b/lisp/bookmark.el index 0a079482ca9..56aec1c4f99 100644 --- a/lisp/bookmark.el +++ b/lisp/bookmark.el @@ -279,7 +279,7 @@ STR-BEFORE-POS is buffer text that immediately precedes POS. ANNOTATION is a string that describes the bookmark. See options `bookmark-use-annotations' and `bookmark-automatically-show-annotations'. -HANDLER is a function that provides the bookmark-jump behavior for a +HANDLER is a function that provides the `bookmark-jump' behavior for a specific kind of bookmark instead of the default `bookmark-default-handler'. This is the case for Info bookmarks, for instance. HANDLER must accept a bookmark as its single argument. diff --git a/lisp/calc/calc-aent.el b/lisp/calc/calc-aent.el index db4751a9fbb..0e913ddfdb9 100644 --- a/lisp/calc/calc-aent.el +++ b/lisp/calc/calc-aent.el @@ -49,7 +49,7 @@ (declare-function math-to-percentsigns "calccomp" (x)) (defvar calc-quick-calc-history nil - "The history list for quick-calc.") + "The history list for `quick-calc'.") ;;;###autoload (defun calc-do-quick-calc (&optional insert) diff --git a/lisp/calc/calc-bin.el b/lisp/calc/calc-bin.el index 503ed777029..a1f4ca43e71 100644 --- a/lisp/calc/calc-bin.el +++ b/lisp/calc/calc-bin.el @@ -202,7 +202,7 @@ (defun math-power-of-2 (n) ; [I I] [Public] (if (natnump n) (ash 1 n) - (error "argument must be a natural number"))) + (error "Argument must be a natural number"))) (defun math-integer-log2 (n) ; [I I] [Public] (and (natnump n) diff --git a/lisp/calc/calc-ext.el b/lisp/calc/calc-ext.el index 45337e187be..dbe2f689d85 100644 --- a/lisp/calc/calc-ext.el +++ b/lisp/calc/calc-ext.el @@ -3418,7 +3418,7 @@ If X is not an error form, return 1." ;;; Users can redefine this in their init files. (defvar calc-keypad-user-menu nil - "If non-nil, this describes an additional menu for calc-keypad. + "If non-nil, this describes an additional menu for `calc-keypad'. It should contain a list of three rows. Each row should be a list of six keys. Each key should be a list of a label string, plus a Calc command name spec. diff --git a/lisp/calc/calc-map.el b/lisp/calc/calc-map.el index 16a2bd89cac..d12d05f3055 100644 --- a/lisp/calc/calc-map.el +++ b/lisp/calc/calc-map.el @@ -139,7 +139,7 @@ (defvar calc-verify-arglist t) (defun calc-map-stack () - "This is meant to be called by calc-keypad mode." + "This is meant to be called by `calc-keypad' mode." (interactive) (let ((calc-verify-arglist nil)) (calc-unread-command ?\$) diff --git a/lisp/calc/calc-menu.el b/lisp/calc/calc-menu.el index 516f62d7b63..eed20a89a47 100644 --- a/lisp/calc/calc-menu.el +++ b/lisp/calc/calc-menu.el @@ -19,6 +19,8 @@ ;;; Commentary: +;;; Code: + (defvar calc-arithmetic-menu (list "Arithmetic" (list "Basic" diff --git a/lisp/calc/calc-misc.el b/lisp/calc/calc-misc.el index b573c53f418..c8394e8c2fa 100644 --- a/lisp/calc/calc-misc.el +++ b/lisp/calc/calc-misc.el @@ -102,8 +102,7 @@ Miscellaneous: 0 (zero) calc-reset. Reset Calc stack and modes to default state. Press `*' twice (`C-x * *') to turn Calc on or off using the same -Calc user interface as before (either C-x * C or C-x * K; initially C-x * C). -" +Calc user interface as before (either C-x * C or C-x * K; initially C-x * C)." (interactive "P") (calc-check-defines) (if calc-dispatch-help diff --git a/lisp/calc/calc-units.el b/lisp/calc/calc-units.el index 8b6f0637035..fd6f3a7b67b 100644 --- a/lisp/calc/calc-units.el +++ b/lisp/calc/calc-units.el @@ -529,7 +529,7 @@ If COMP or STD is non-nil, put that in the units table instead." (calc-slow-wrapper (let* ((expr (calc-top-n 1))) (unless (math-units-in-expr-p expr t) - (error "No units in expression.")) + (error "No units in expression")) (let* ((old-units (math-extract-units expr)) (defunits (math-get-default-units expr)) units diff --git a/lisp/calc/calc.el b/lisp/calc/calc.el index 800ec7a6a38..afb43c0f338 100644 --- a/lisp/calc/calc.el +++ b/lisp/calc/calc.el @@ -252,7 +252,7 @@ (defcustom calc-embedded-announce-formula "%Embed\n\\(% .*\n\\)*" - "A regular expression which is sure to be followed by a calc-embedded formula." + "A regular expression which is sure to be followed by a `calc-embedded' formula." :type '(regexp)) (defcustom calc-embedded-announce-formula-alist @@ -278,12 +278,12 @@ (defcustom calc-embedded-close-formula "\\'\\|\n$\\|\\$\\$?\\|\\\\]\\|^\\\\end[^{].*\n\\|^\\\\end{.*[^x]}.*\n\\|^@.*\n\\|^\\.EN.*\n\\|\\\\)\\|\n%\n\\|^\\.\\\\\"\n" - "Regexp for the closing delimiter of a formula used by calc-embedded." + "Regexp for the closing delimiter of a formula used by `calc-embedded'." :type '(regexp)) (defcustom calc-embedded-open-close-formula-alist nil - "Alist of major modes with pairs of formula delimiters used by calc-embedded." + "Alist of major modes with pairs of formula delimiters used by `calc-embedded'." :type '(alist :key-type (symbol :tag "Major mode") :value-type (list (regexp :tag "Opening formula delimiter") (regexp :tag "Closing formula delimiter")))) @@ -348,13 +348,13 @@ See calc-embedded-open-plain." (defcustom calc-embedded-open-mode "% " - "A string which should precede calc-embedded mode annotations. + "A string which should precede `calc-embedded' mode annotations. This is not required to be present for user-written mode annotations." :type '(string)) (defcustom calc-embedded-close-mode "\n" - "A string which should follow calc-embedded mode annotations. + "A string which should follow `calc-embedded' mode annotations. This is not required to be present for user-written mode annotations." :type '(string)) @@ -387,43 +387,35 @@ This is not required to be present for user-written mode annotations." :type '(string) :version "26.2") -(defcustom calc-gnuplot-plot-command - nil +(defcustom calc-gnuplot-plot-command nil "Name of command for displaying GNUPLOT output; %s = file name to print." :type '(choice (string) (sexp))) -(defcustom calc-gnuplot-print-command - "lp %s" +(defcustom calc-gnuplot-print-command "lp %s" "Name of command for printing GNUPLOT output; %s = file name to print." :type '(choice (string) (sexp))) -(defcustom calc-multiplication-has-precedence - t - "If non-nil, multiplication has precedence over division -in normal mode." +(defcustom calc-multiplication-has-precedence t + "If non-nil, multiplication has precedence over division in normal mode." :type 'boolean) -(defcustom calc-ensure-consistent-units - nil +(defcustom calc-ensure-consistent-units nil "If non-nil, make sure new units are consistent with current units when converting units." :version "24.3" :type 'boolean) -(defcustom calc-context-sensitive-enter - nil +(defcustom calc-context-sensitive-enter nil "If non-nil, the stack element under the cursor will be copied by `calc-enter' and deleted by `calc-pop'." :version "24.4" :type 'boolean) -(defcustom calc-undo-length - 100 +(defcustom calc-undo-length 100 "The number of undo steps that will be preserved when Calc is quit." :type 'integer) -(defcustom calc-highlight-selections-with-faces - nil +(defcustom calc-highlight-selections-with-faces nil "If non-nil, use a separate face to indicate selected sub-formulas. If option `calc-show-selections' is non-nil, then selected sub-formulas are shown by displaying the rest of the formula in `calc-nonselected-face'. @@ -432,14 +424,12 @@ by displaying the sub-formula in `calc-selected-face'." :version "24.1" :type 'boolean) -(defcustom calc-lu-field-reference - "20 uPa" +(defcustom calc-lu-field-reference "20 uPa" "The default reference level for logarithmic units (field)." :version "24.1" :type '(string)) -(defcustom calc-lu-power-reference - "mW" +(defcustom calc-lu-power-reference "mW" "The default reference level for logarithmic units (power)." :version "24.1" :type '(string)) @@ -496,7 +486,7 @@ This setting only applies to floats in normal display mode.") "List of strings for Y prefix help.") (defvar calc-loaded-settings-file nil - "t if `calc-settings-file' has been loaded yet.") + "Return t if `calc-settings-file' has been loaded yet.") (defvar calc-mode-var-list '() @@ -961,7 +951,7 @@ Used by `calc-user-invocation'.") (defvar calc-lang-allow-percentsigns nil "A list of languages which allow percent signs in variable names.") (defvar calc-lang-c-type-hex nil - "Languages in which octal and hex numbers are written with leading 0 and 0x,") + "Languages in which octal and hex numbers are written with leading 0 and 0x.") (defvar calc-lang-brackets-are-subscripts nil "Languages in which subscripts are indicated by brackets.") (defvar calc-lang-parens-are-subscripts nil @@ -1311,8 +1301,7 @@ Notations: 3.14e6 3.14 * 10^6 <1 jan 91> Date form (enter using \\=' key) -\\{calc-mode-map} -" +\\{calc-mode-map}" (interactive) (mapc (lambda (v) ;; FIXME: Why (set-default v (symbol-value v)) ?!?!? @@ -1383,12 +1372,12 @@ Notations: 3.14e6 3.14 * 10^6 map)) (defun calc--header-line (long short width &optional fudge) - "Return a Calc header line appropriate for the buffer width. + "Return a Calc header line appropriate for the buffer WIDTH. LONG is a desired text for a wide window, SHORT is a desired abbreviated text, and width is the buffer width, which will be some fraction of the 'parent' window width (At the time of -writing, 2/3 for calc, 1/3 for trail). The optional FUDGE is a +writing, 2/3 for calc, 1/3 for trail). The optional FUDGE is a trial-and-error adjustment number for the edge-cases at the border of the two cases." ;; TODO: This could be called as part of a 'window-resize' hook. @@ -1410,7 +1399,7 @@ border of the two cases." This mode is used by the *Calc Trail* buffer, which records all results obtained by the GNU Emacs Calculator. -Calculator commands beginning with the `t' key are used to manipulate +Calculator commands beginning with the t key are used to manipulate the Trail. This buffer uses the same key map as the *Calculator* buffer; calculator @@ -1501,7 +1490,7 @@ See `window-dedicated-p' for what that means." (calc nil t interactive)) (defun calc-same-interface (arg) - "Invoke the Calculator using the most recent interface (calc or calc-keypad)." + "Invoke the Calculator using the most recent interface (`calc' or `calc-keypad')." (interactive "P") (if (and (equal (buffer-name) "*Gnuplot Trail*") (> (recursion-depth) 0)) @@ -1578,7 +1567,7 @@ or a list containing a character position and an error message in string form." "Invoke the Calculator in \"visual keypad\" mode. This is most useful in the X window system. In this mode, click on the Calc \"buttons\" using the left mouse button. -Or, position the cursor manually and do M-x calc-keypad-press." +Or, position the cursor manually and do \\[calc-keypad-press]." (interactive "p") (require 'calc-ext) (calc-do-keypad calc-full-mode interactive)) diff --git a/lisp/calculator.el b/lisp/calculator.el index 99c9b6290c4..415e0b4c77c 100644 --- a/lisp/calculator.el +++ b/lisp/calculator.el @@ -1475,8 +1475,7 @@ a multiplication." (calculator-put-value (calculator-string-to-number str))))) (defun calculator-register-read-with-preview (prompt) - "Similar to `register-read-with-preview' but for calculator -registers." + "Similar to `register-read-with-preview' but for calculator registers." (let ((register-alist calculator-registers) (register-preview-delay 1) (register-preview-function diff --git a/lisp/calendar/cal-tex.el b/lisp/calendar/cal-tex.el index 7b55d420c3b..75e106cb376 100644 --- a/lisp/calendar/cal-tex.el +++ b/lisp/calendar/cal-tex.el @@ -263,7 +263,7 @@ Optional string ARGS are included as options for the article document class with inclusion of default values \"12pt\" for size, and \"a4paper\" for paper unless size or paper are already specified in ARGS. When ARGS is omitted, by default the option -\"12pt,a4paper\" is passed. When ARGS has any other value, then +\"12pt,a4paper\" is passed. When ARGS has any other value, then no option is passed to the class. Insert the \"\\usepackage{geometry}\" directive when ARGS diff --git a/lisp/calendar/icalendar.el b/lisp/calendar/icalendar.el index eaee2e9d951..312d5e2f380 100644 --- a/lisp/calendar/icalendar.el +++ b/lisp/calendar/icalendar.el @@ -1749,7 +1749,7 @@ entries. ENTRY-MAIN is the first line of the diary entry." (defun icalendar--convert-float-to-ical (nonmarker entry-main) "Convert float diary entry to iCalendar format -- partially unsupported! - FIXME! DAY from diary-float yet unimplemented. + FIXME! DAY from `diary-float' yet unimplemented. NONMARKER is a regular expression matching the start of non-marking entries. ENTRY-MAIN is the first line of the diary entry." diff --git a/lisp/calendar/todo-mode.el b/lisp/calendar/todo-mode.el index 371d10631c5..68e29d4cec9 100644 --- a/lisp/calendar/todo-mode.el +++ b/lisp/calendar/todo-mode.el @@ -6543,8 +6543,8 @@ Filtered Items mode following todo (not done) items." map) "Todo Filtered Items mode keymap.") -(easy-menu-define - todo-menu todo-mode-map "Todo Menu" +(easy-menu-define todo-menu todo-mode-map + "Todo Menu." '("Todo" ("Navigation" ["Next Item" todo-next-item t] diff --git a/lisp/cedet/ede/auto.el b/lisp/cedet/ede/auto.el index ee9d0116af3..da6a3f3e903 100644 --- a/lisp/cedet/ede/auto.el +++ b/lisp/cedet/ede/auto.el @@ -69,7 +69,7 @@ into memory.") (let* ((fc (oref dirmatch fromconfig)) (found (cond ((stringp fc) fc) ((functionp fc) (funcall fc)) - (t (error "Unknown dirmatch object match style."))))) + (t (error "Unknown dirmatch object match style"))))) (expand-file-name found) )) @@ -129,7 +129,7 @@ into memory.") ;; Error if none others known (t - (error "Unknown dirmatch object match style."))) + (error "Unknown dirmatch object match style"))) )) (declare-function ede-directory-safe-p "ede") diff --git a/lisp/cedet/ede/cpp-root.el b/lisp/cedet/ede/cpp-root.el index 652d6476f02..fd37e53ed42 100644 --- a/lisp/cedet/ede/cpp-root.el +++ b/lisp/cedet/ede/cpp-root.el @@ -103,7 +103,7 @@ ;; ;; If the cpp-root project style is right for you, but you want a ;; dynamic loader, instead of hard-coding values in your .emacs, you -;; can do that too, but you will need to write some lisp code. +;; can do that too, but you will need to write some Lisp code. ;; ;; To do that, you need to add an entry to the ;; `ede-project-class-files' list, and also provide two functions to diff --git a/lisp/cedet/ede/makefile-edit.el b/lisp/cedet/ede/makefile-edit.el index d6965945494..709963d6faf 100644 --- a/lisp/cedet/ede/makefile-edit.el +++ b/lisp/cedet/ede/makefile-edit.el @@ -30,7 +30,7 @@ ;; Formatting of a makefile ;; ;; 1) Creating an automakefile, stick in a top level comment about -;; being created by emacs +;; being created by Emacs. ;; 2) Leave order of variable contents alone, except for SOURCE ;; SOURCE always keep in the order of .c, .h, the other stuff. diff --git a/lisp/cedet/ede/proj-elisp.el b/lisp/cedet/ede/proj-elisp.el index 7e0f5a89346..7a3b36f30f6 100644 --- a/lisp/cedet/ede/proj-elisp.el +++ b/lisp/cedet/ede/proj-elisp.el @@ -54,8 +54,8 @@ load path." Each package name will be loaded with `require'. Each package's directory should also appear in :aux-packages via a package name.") ) - "This target consists of a group of lisp files. -A lisp target may be one general program with many separate lisp files in it.") + "This target consists of a group of Lisp files. +A Lisp target may be one general program with many separate Lisp files in it.") (cl-defmethod ede-proj-makefile-insert-rules :after ((this ede-proj-target-elisp)) "Insert rules needed by THIS target. diff --git a/lisp/cedet/ede/proj.el b/lisp/cedet/ede/proj.el index c8c34d092f1..1352e5c193d 100644 --- a/lisp/cedet/ede/proj.el +++ b/lisp/cedet/ede/proj.el @@ -562,7 +562,7 @@ Converts all symbols into the objects to be used." ;; Provide a good error msg. (unless comp (error "Could not find compiler match for source code extension \"%s\". -You may need to add support for this type of file." +You may need to add support for this type of file" (if sources (file-name-extension (car sources)) ""))) diff --git a/lisp/cedet/ede/project-am.el b/lisp/cedet/ede/project-am.el index 258917f01b9..e7f5640c07f 100644 --- a/lisp/cedet/ede/project-am.el +++ b/lisp/cedet/ede/project-am.el @@ -130,7 +130,7 @@ other meta-variable based on this name.") (defclass project-am-program (project-am-objectcode) ((ldadd :initarg :ldadd :documentation "Additional LD args." :initform nil)) - "A top level program to build") + "A top level program to build.") (defclass project-am-header (project-am-target) () @@ -154,7 +154,7 @@ other meta-variable based on this name.") (defclass project-am-lib (project-am-objectcode) nil - "A top level library to build") + "A top level library to build.") (defclass project-am-lisp (project-am-target) () @@ -705,7 +705,7 @@ Strip out duplicates, and recurse on variables." (oset this source (makefile-macro-file-list (project-am-macro this)))) (cl-defmethod project-rescan ((this project-am-lisp)) - "Rescan the lisp sources." + "Rescan the Lisp sources." (oset this source (makefile-macro-file-list (project-am-macro this)))) (cl-defmethod project-rescan ((this project-am-header)) diff --git a/lisp/cedet/ede/source.el b/lisp/cedet/ede/source.el index 5dbad4fcc00..338b03d25dc 100644 --- a/lisp/cedet/ede/source.el +++ b/lisp/cedet/ede/source.el @@ -91,12 +91,12 @@ that they are willing to use.") (ede-want-file-auxiliary-p this filename))) (cl-defmethod ede-want-file-source-p ((this ede-sourcecode) filename) - "Return non-nil if THIS will take FILENAME as an auxiliary ." + "Return non-nil if THIS will take FILENAME as an auxiliary." (let ((case-fold-search nil)) (string-match (oref this sourcepattern) filename))) (cl-defmethod ede-want-file-auxiliary-p ((this ede-sourcecode) filename) - "Return non-nil if THIS will take FILENAME as an auxiliary ." + "Return non-nil if THIS will take FILENAME as an auxiliary." (let ((case-fold-search nil)) (and (slot-boundp this 'auxsourcepattern) (oref this auxsourcepattern) diff --git a/lisp/cedet/mode-local.el b/lisp/cedet/mode-local.el index 247f78ecff7..02d69a1686c 100644 --- a/lisp/cedet/mode-local.el +++ b/lisp/cedet/mode-local.el @@ -773,11 +773,11 @@ SYMBOL is a function that can be overridden." (defconst xref-mode-local-find-overloadable-regexp "(define-overload\\(able-function\\)? +%s" "Regexp used by `xref-find-definitions' when searching for a - mode-local overloadable function definition.") +mode-local overloadable function definition.") (defun xref-mode-local-find-override (meta-name) "Function used by `xref-find-definitions' when searching for an - override of a mode-local overloadable function. +override of a mode-local overloadable function. META-NAME is a cons (OVERLOADABLE-SYMBOL . MAJOR-MODE)." (let* ((override (car meta-name)) (mode (cdr meta-name)) diff --git a/lisp/cedet/semantic.el b/lisp/cedet/semantic.el index fb443fa4a32..205d6a812a2 100644 --- a/lisp/cedet/semantic.el +++ b/lisp/cedet/semantic.el @@ -271,7 +271,7 @@ a parse of the buffer.") (defsubst semantic-error-if-unparsed () "Raise an error if current buffer was not parsed by Semantic." (unless semantic-new-buffer-fcn-was-run - (error "Buffer was not parsed by Semantic."))) + (error "Buffer was not parsed by Semantic"))) (defsubst semantic--umatched-syntax-needs-refresh-p () "Return non-nil if the unmatched syntax cache needs a refresh. diff --git a/lisp/cedet/semantic/analyze/complete.el b/lisp/cedet/semantic/analyze/complete.el index ccf405d62e2..1e8cd9af088 100644 --- a/lisp/cedet/semantic/analyze/complete.el +++ b/lisp/cedet/semantic/analyze/complete.el @@ -107,7 +107,7 @@ in a buffer." ;; Buffer was not parsed by Semantic. ;; Raise error if called interactively. (when (called-interactively-p 'any) - (error "Buffer was not parsed by Semantic.")))) + (error "Buffer was not parsed by Semantic")))) (defvar semantic--prefixtypes) diff --git a/lisp/cedet/semantic/bovine/c.el b/lisp/cedet/semantic/bovine/c.el index e7ecb61513f..c7d59def1f1 100644 --- a/lisp/cedet/semantic/bovine/c.el +++ b/lisp/cedet/semantic/bovine/c.el @@ -1937,7 +1937,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 + "For a single INCLUDETAG found in TABLE, find a `semanticdb-table' object. 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. @@ -2034,7 +2034,7 @@ for arguments compared." (if blankok t (semantic--tag-similar-names-p-default tag1 tag2 nil))) (define-mode-local-override semantic--tag-similar-types-p c-mode (tag1 tag2) - "For c-mode, deal with TAG1 and TAG2 being used in different namespaces. + "For `c-mode', deal with TAG1 and TAG2 being used in different namespaces. In this case, one type will be shorter than the other. Instead of fully resolving all namespaces currently in scope for both types, we simply compare as many elements as the shorter type @@ -2064,7 +2064,7 @@ provides." (define-mode-local-override semantic--tag-attribute-similar-p c-mode (attr value1 value2 ignorable-attributes) - "For c-mode, allow function :arguments to ignore the :name attributes." + "For `c-mode', allow function :arguments to ignore the :name attributes." (cond ((eq attr :arguments) (semantic--tag-attribute-similar-p-default attr value1 value2 (cons :name ignorable-attributes))) diff --git a/lisp/cedet/semantic/bovine/debug.el b/lisp/cedet/semantic/bovine/debug.el index 47850a5d1f4..64ccbb45195 100644 --- a/lisp/cedet/semantic/bovine/debug.el +++ b/lisp/cedet/semantic/bovine/debug.el @@ -113,7 +113,7 @@ LEXTOKEN, is a token returned by the lexer which is being matched." :documentation "An error condition caught in an action.") ) - "Debugger frame representation of a lisp error thrown during parsing.") + "Debugger frame representation of a Lisp error thrown during parsing.") (defun semantic-create-bovine-debug-error-frame (condition) "Create an error frame for bovine debugger. diff --git a/lisp/cedet/semantic/complete.el b/lisp/cedet/semantic/complete.el index 5d34b308d0a..6cfbdd5f03f 100644 --- a/lisp/cedet/semantic/complete.el +++ b/lisp/cedet/semantic/complete.el @@ -930,7 +930,7 @@ inserted into the current context.") (cl-defmethod semantic-collector-calculate-completions-raw ((obj semantic-collector-analyze-completions) prefix _completionlist) - "calculate the completions for prefix from COMPLETIONLIST." + "Calculate the completions for prefix from COMPLETIONLIST." ;; if there are no completions yet, calculate them. (if (not (slot-boundp obj 'first-pass-completions)) (oset obj first-pass-completions diff --git a/lisp/cedet/semantic/db-el.el b/lisp/cedet/semantic/db-el.el index 41e48b0bc30..c9ae68e9fa7 100644 --- a/lisp/cedet/semantic/db-el.el +++ b/lisp/cedet/semantic/db-el.el @@ -328,7 +328,7 @@ Like `semanticdb-find-tags-for-completion-method' for Emacs Lisp." ;; (cl-defmethod semanticdb-find-tags-external-children-of-type-method ((_table semanticdb-table-emacs-lisp) type &optional tags) - "Find all nonterminals which are child elements of TYPE + "Find all nonterminals which are child elements of TYPE. Optional argument TAGS is a list of tags to search. Return a list of tags." (if tags (cl-call-next-method) diff --git a/lisp/cedet/semantic/db-find.el b/lisp/cedet/semantic/db-find.el index c96a426280e..61baaa020f8 100644 --- a/lisp/cedet/semantic/db-find.el +++ b/lisp/cedet/semantic/db-find.el @@ -315,7 +315,7 @@ Default action as described in `semanticdb-find-translate-path'." ;;;###autoload (define-overloadable-function semanticdb-find-table-for-include (includetag &optional table) - "For a single INCLUDETAG found in TABLE, find a `semanticdb-table' object + "For a single INCLUDETAG found in TABLE, find a `semanticdb-table' object. 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-typecache.el b/lisp/cedet/semantic/db-typecache.el index c0fee3b2bd9..03158171a29 100644 --- a/lisp/cedet/semantic/db-typecache.el +++ b/lisp/cedet/semantic/db-typecache.el @@ -547,8 +547,7 @@ found tag to be loaded." (cl-defmethod semanticdb-typecache-for-database ((db semanticdb-project-database) &optional mode) "Return the typecache for the project database DB. -If there isn't one, create it. -" +If there isn't one, create it." (let ((lmode (or mode major-mode)) (cache (semanticdb-get-typecache db)) (stream nil) diff --git a/lisp/cedet/semantic/debug.el b/lisp/cedet/semantic/debug.el index 4f96746166b..c13952265e6 100644 --- a/lisp/cedet/semantic/debug.el +++ b/lisp/cedet/semantic/debug.el @@ -108,7 +108,7 @@ These buffers are brought into view when layout occurs.") :documentation "Any active overlays being used to show the debug position.") ) - "Controls action when in `semantic-debug-mode'") + "Controls action when in `semantic-debug-mode'.") ;; Methods (cl-defmethod semantic-debug-set-frame ((iface semantic-debug-interface) frame) @@ -559,10 +559,8 @@ down to your parser later." (cl-defmethod semantic-debug-parser-frames ((_parser semantic-debug-parser)) "Return a list of frames for the current parser. A frame is of the form: - ( .. .what ? .. ) -" - (error "Parser has not implemented frame values") - ) + ( .. .what ? .. )" + (error "Parser has not implemented frame values")) (provide 'semantic/debug) diff --git a/lisp/cedet/semantic/decorate/include.el b/lisp/cedet/semantic/decorate/include.el index 389b3062c5d..ae2895c2b93 100644 --- a/lisp/cedet/semantic/decorate/include.el +++ b/lisp/cedet/semantic/decorate/include.el @@ -66,7 +66,7 @@ Used by the decoration style: `semantic-decoration-on-includes'." (easy-menu-define semantic-decoration-on-include-menu semantic-decoration-on-include-map - "Include Menu" + "Include Menu." (list "Include" ["What Is This?" semantic-decoration-include-describe @@ -124,7 +124,7 @@ Used by the decoration style: `semantic-decoration-on-unknown-includes'." (easy-menu-define semantic-decoration-on-unknown-include-menu semantic-decoration-on-unknown-include-map - "Unknown Include Menu" + "Unknown Include Menu." (list "Unknown Include" ["What Is This?" semantic-decoration-unknown-include-describe @@ -179,7 +179,7 @@ Used by the decoration style: `semantic-decoration-on-fileless-includes'." (easy-menu-define semantic-decoration-on-fileless-include-menu semantic-decoration-on-fileless-include-map - "Fileless Include Menu" + "Fileless Include Menu." (list "Fileless Include" ["What Is This?" semantic-decoration-fileless-include-describe @@ -234,7 +234,7 @@ Used by the decoration style: `semantic-decoration-on-unparsed-includes'." (easy-menu-define semantic-decoration-on-unparsed-include-menu semantic-decoration-on-unparsed-include-map - "Unparsed Include Menu" + "Unparsed Include Menu." (list "Unparsed Include" ["What Is This?" semantic-decoration-unparsed-include-describe diff --git a/lisp/cedet/semantic/ede-grammar.el b/lisp/cedet/semantic/ede-grammar.el index 19d4184fa45..9a4d412d5d3 100644 --- a/lisp/cedet/semantic/ede-grammar.el +++ b/lisp/cedet/semantic/ede-grammar.el @@ -185,7 +185,7 @@ max-lisp-eval-depth 700)'\n" (cl-defmethod ede-proj-makefile-insert-dist-dependencies ((this semantic-ede-proj-target-grammar)) "Insert dist dependencies, or intermediate targets. -This makes sure that all grammar lisp files are created before the dist +This makes sure that all grammar Lisp files are created before the dist runs, so they are always up to date. Argument THIS is the target that should insert stuff." (cl-call-next-method) diff --git a/lisp/cedet/semantic/fw.el b/lisp/cedet/semantic/fw.el index 4ad70ff7c64..16e8ce8de95 100644 --- a/lisp/cedet/semantic/fw.el +++ b/lisp/cedet/semantic/fw.el @@ -284,7 +284,7 @@ later installation should be done in MODE hook." (defvar semantic-current-input-throw-symbol nil "The current throw symbol for `semantic-exit-on-input'.") (defvar semantic--on-input-start-marker nil - "The marker when starting a semantic-exit-on-input form.") + "The marker when starting a `semantic-exit-on-input' form.") (defmacro semantic-exit-on-input (symbol &rest forms) "Using SYMBOL as an argument to `throw', execute FORMS. diff --git a/lisp/cedet/semantic/grammar.el b/lisp/cedet/semantic/grammar.el index 4c3bb6c238b..33c66da9a62 100644 --- a/lisp/cedet/semantic/grammar.el +++ b/lisp/cedet/semantic/grammar.el @@ -840,7 +840,7 @@ If optional argument FORCE is non-nil, unconditionally re-generate the Lisp code." (interactive "P") (unless (semantic-active-p) - (error "You have to activate semantic-mode to create a package.")) + (error "You have to activate semantic-mode to create a package")) (setq force (or force current-prefix-arg)) (semantic-fetch-tags) (let* ( diff --git a/lisp/cedet/semantic/idle.el b/lisp/cedet/semantic/idle.el index c058e8a8b50..b1805f720d0 100644 --- a/lisp/cedet/semantic/idle.el +++ b/lisp/cedet/semantic/idle.el @@ -1070,7 +1070,7 @@ be called." (easy-menu-define semantic-idle-breadcrumbs-popup-menu semantic-idle-breadcrumbs-popup-map - "Semantic Breadcrumbs Mode Menu" + "Semantic Breadcrumbs Mode Menu." (list "Breadcrumb Tag" (vector diff --git a/lisp/cedet/semantic/symref/grep.el b/lisp/cedet/semantic/symref/grep.el index e06a3c10078..53745b429a2 100644 --- a/lisp/cedet/semantic/symref/grep.el +++ b/lisp/cedet/semantic/symref/grep.el @@ -39,7 +39,7 @@ ) "A symref tool implementation using grep. This tool uses EDE to find the root of the project, then executes -find-grep in the project. The output is parsed for hits and +`find-grep' in the project. The output is parsed for hits and those hits returned.") (defvar semantic-symref-filepattern-alist diff --git a/lisp/cedet/semantic/symref/list.el b/lisp/cedet/semantic/symref/list.el index 2e447bbc582..b1b36132b35 100644 --- a/lisp/cedet/semantic/symref/list.el +++ b/lisp/cedet/semantic/symref/list.el @@ -152,7 +152,7 @@ Display the references in `semantic-symref-results-mode'." (easy-menu-define semantic-symref-list-menu semantic-symref-results-mode-map - "Symref Mode Menu" + "Symref Mode Menu." semantic-symref-list-menu-entries) (defcustom semantic-symref-auto-expand-results nil diff --git a/lisp/cedet/semantic/tag.el b/lisp/cedet/semantic/tag.el index b6386d71db0..a86ed020bbb 100644 --- a/lisp/cedet/semantic/tag.el +++ b/lisp/cedet/semantic/tag.el @@ -119,8 +119,7 @@ Statement that represents a file from which more tags can be found. Statement that declares this file's package name. @item code Code that has not name or binding to any other symbol, such as in a script. -@end table -" +@end table" (nth 1 tag)) (defsubst semantic-tag-attributes (tag) @@ -703,7 +702,7 @@ It is safe for FILTER to modify the input tag and return it." It is safe to modify ATTR, and return a permutation of that list. -FILTER takes TAG as an argument, and should returns a semantic-tag. +FILTER takes TAG as an argument, and should return a semantic-tag. It is safe for FILTER to modify the input tag and return it." (when (car attrs) (when (not (symbolp (car attrs))) (error "Bad Attribute List in tag")) @@ -716,7 +715,7 @@ It is safe for FILTER to modify the input tag and return it." It is safe to modify VALUE, and return a permutation of that list. -FILTER takes TAG as an argument, and should returns a semantic-tag. +FILTER takes TAG as an argument, and should return a semantic-tag. It is safe for FILTER to modify the input tag and return it." (cond ;; Another tag. @@ -735,7 +734,7 @@ It is safe for FILTER to modify the input tag and return it." It is safe to modify the TAGS list, and return a permutation of that list. -FILTER takes TAG as an argument, and should returns a semantic-tag. +FILTER takes TAG as an argument, and should return a semantic-tag. It is safe for FILTER to modify the input tag and return it." (when (car tags) (if (semantic-tag-p (car tags)) @@ -1309,12 +1308,12 @@ This function is overridable with the symbol `insert-foreign-tag'." ;;; Support log modes here (define-mode-local-override semantic-insert-foreign-tag log-edit-mode (foreign-tag) - "Insert foreign tags into log-edit mode." + "Insert foreign tags into `log-edit' mode." (insert (concat "(" (semantic-format-tag-name foreign-tag) "): "))) (define-mode-local-override semantic-insert-foreign-tag change-log-mode (foreign-tag) - "Insert foreign tags into log-edit mode." + "Insert foreign tags into `log-edit' mode." (insert (concat "(" (semantic-format-tag-name foreign-tag) "): "))) diff --git a/lisp/cedet/semantic/util-modes.el b/lisp/cedet/semantic/util-modes.el index 106862837a1..5ce1108044a 100644 --- a/lisp/cedet/semantic/util-modes.el +++ b/lisp/cedet/semantic/util-modes.el @@ -565,7 +565,7 @@ to indicate a parse in progress." (easy-menu-define semantic-stickyfunc-popup-menu semantic-stickyfunc-mode-map - "Stickyfunc Menu" + "Stickyfunc Menu." '("Stickyfunc Mode" :visible (progn nil) [ "Copy Headerline Tag" senator-copy-tag :active (semantic-current-tag) @@ -837,7 +837,7 @@ Used by `semantic-highlight-func-mode'.") (easy-menu-define semantic-highlight-func-popup-menu semantic-highlight-func-mode-map - "Highlight-Func Menu" + "Highlight-Func Menu." '("Highlight-Func Mode" :visible (progn nil) [ "Copy Tag" senator-copy-tag :active (semantic-current-tag) diff --git a/lisp/cedet/srecode/ctxt.el b/lisp/cedet/srecode/ctxt.el index c49237b94cf..fe887c281c3 100644 --- a/lisp/cedet/srecode/ctxt.el +++ b/lisp/cedet/srecode/ctxt.el @@ -60,7 +60,7 @@ Some useful context values used by the provided srecode templates are: \"pure\" - and those virtual items are pure virtual \"type\" - In or near type declarations. \"comment\" - In a comment in a block of code - -- these items show up at the end of the context list. -- + -- these items show up at the end of the context list. -- \"public\", \"protected\", \"private\" - In or near a section of public/protected/private entries. \"code\" - In a block of code. diff --git a/lisp/cedet/srecode/dictionary.el b/lisp/cedet/srecode/dictionary.el index 5da045e17f1..d6dfc58411e 100644 --- a/lisp/cedet/srecode/dictionary.el +++ b/lisp/cedet/srecode/dictionary.el @@ -410,7 +410,7 @@ OTHERDICT." "Return information about DICT's value for NAME. DICT is a dictionary, and NAME is a string that is treated as the name of an entry in the dictionary. If such an entry exists, its -value is returned. Otherwise, nil is returned. Normally, the +value is returned. Otherwise, nil is returned. Normally, the lookup is recursive in the sense that the parent of DICT is searched for NAME if it is not found in DICT. This recursive lookup can be disabled by the optional argument NON-RECURSIVE. diff --git a/lisp/cedet/srecode/semantic.el b/lisp/cedet/srecode/semantic.el index 101246cae6f..fbb6984dc15 100644 --- a/lisp/cedet/srecode/semantic.el +++ b/lisp/cedet/srecode/semantic.el @@ -201,7 +201,7 @@ variable default values, and other things." (let ((tag (or srecode-semantic-selected-tag (srecode-semantic-tag-from-kill-ring)))) (when (not tag) - (error "No tag for current template. Use the semantic kill-ring.")) + (error "No tag for current template. Use the semantic kill-ring")) (srecode-semantic-apply-tag-to-dict (srecode-semantic-tag (semantic-tag-name tag) :prime tag) diff --git a/lisp/cmuscheme.el b/lisp/cmuscheme.el index 18087da9ac9..0910ea6187e 100644 --- a/lisp/cmuscheme.el +++ b/lisp/cmuscheme.el @@ -33,15 +33,15 @@ ;; merge them into the master source. ;; ;; NOTE: MIT Cscheme, when invoked with the -emacs flag, has a special user -;; interface that communicates process state back to the superior emacs by +;; interface that communicates process state back to the superior Emacs by ;; outputting special control sequences. The Emacs package, xscheme.el, has ;; lots and lots of special purpose code to read these control sequences, and ;; so is very tightly integrated with the cscheme process. The cscheme ;; interrupt handler and debugger read single character commands in cbreak ;; mode; when this happens, xscheme.el switches to special keymaps that bind -;; the single letter command keys to emacs functions that directly send the +;; the single letter command keys to Emacs functions that directly send the ;; character to the scheme process. Cmuscheme mode does *not* provide this -;; functionality. If you are a cscheme user, you may prefer to use the +;; functionality. If you are a cscheme user, you may prefer to use the ;; xscheme.el/cscheme -emacs interaction. ;; ;; Here's a summary of the pros and cons, as I see them. @@ -159,7 +159,7 @@ The following commands are available: \\{inferior-scheme-mode-map} -A Scheme process can be fired up with M-x run-scheme. +A Scheme process can be fired up with \\[run-scheme]. Customization: Entry to this mode runs the hooks on `comint-mode-hook' and `inferior-scheme-mode-hook' (in that order). diff --git a/lisp/comint.el b/lisp/comint.el index 02878cc6419..56d4420e609 100644 --- a/lisp/comint.el +++ b/lisp/comint.el @@ -191,7 +191,7 @@ wish to put something like the following in your init file: (define-key comint-mode-map [remap kill-whole-line] \\='comint-kill-whole-line))) -If you sometimes use comint-mode on text-only terminals or with `emacs -nw', +If you sometimes use `comint-mode' on text-only terminals or with `emacs -nw', you might wish to use another binding for `comint-kill-whole-line'." :type 'boolean :group 'comint diff --git a/lisp/completion.el b/lisp/completion.el index 93a869e86f4..e36c7228416 100644 --- a/lisp/completion.el +++ b/lisp/completion.el @@ -178,7 +178,7 @@ ;; Inserts a completion at point ;; ;; completion-initialize -;; Loads the completions file and sets up so that exiting emacs will +;; Loads the completions file and sets up so that exiting Emacs will ;; save them. ;; ;; save-completions-to-file &optional filename @@ -207,7 +207,7 @@ ;; Add package prefix smarts (for Common Lisp) ;; Add autoprompting of possible completions after every keystroke (fast ;; terminals only !) -;; Add doc. to texinfo +;; Add documentation to texinfo ;; ;; ;;----------------------------------------------- diff --git a/lisp/composite.el b/lisp/composite.el index 6f654df15aa..a16c0cc2370 100644 --- a/lisp/composite.el +++ b/lisp/composite.el @@ -864,7 +864,7 @@ Auto Composition mode in all buffers (this is the default)." "Toggle Auto Composition mode in all buffers. For more information on Auto Composition mode, see -`auto-composition-mode' ." +`auto-composition-mode'." :global t :variable (default-value 'auto-composition-mode)) diff --git a/lisp/delim-col.el b/lisp/delim-col.el index 1153961468e..ac78e568da2 100644 --- a/lisp/delim-col.el +++ b/lisp/delim-col.el @@ -276,7 +276,7 @@ See the `delimit-columns-str-before', `delimit-columns-before', `delimit-columns-after', `delimit-columns-separator', `delimit-columns-format' and `delimit-columns-extra' variables for customization of the -look. " +look." (interactive "*r") (if rectangle-mark-mode ;; Delegate to delimit-columns-rectangle when called with a diff --git a/lisp/descr-text.el b/lisp/descr-text.el index f5e467d37e7..7ab90d08acc 100644 --- a/lisp/descr-text.el +++ b/lisp/descr-text.el @@ -97,7 +97,7 @@ into help buttons that call `describe-text-category' or ;;; Describe-Text Commands. (defun describe-text-category (category) - "Describe a text property category." + "Describe a text property CATEGORY." (interactive "SCategory: ") (help-setup-xref (list #'describe-text-category category) (called-interactively-p 'interactive)) diff --git a/lisp/dired-aux.el b/lisp/dired-aux.el index c7286429179..53fbcfb6d0b 100644 --- a/lisp/dired-aux.el +++ b/lisp/dired-aux.el @@ -2340,9 +2340,9 @@ If DIRECTORY already exists, signal an error." ;;;###autoload (defun dired-create-empty-file (file) "Create an empty file called FILE. - Add a new entry for the new file in the Dired buffer. - Parent directories of FILE are created as needed. - If FILE already exists, signal an error." +Add a new entry for the new file in the Dired buffer. +Parent directories of FILE are created as needed. +If FILE already exists, signal an error." (interactive (list (read-file-name "Create empty file: "))) (let* ((expanded (expand-file-name file)) new) diff --git a/lisp/dired.el b/lisp/dired.el index 9978d027a98..266a03e6cc3 100644 --- a/lisp/dired.el +++ b/lisp/dired.el @@ -315,12 +315,12 @@ new Dired buffers." (defcustom dired-always-read-filesystem nil "Non-nil means revert buffers visiting files before searching them. - By default, commands like `dired-mark-files-containing-regexp' will - search any buffers visiting the marked files without reverting them, - even if they were changed on disk. When this option is non-nil, such - buffers are always reverted in a temporary buffer before searching - them: the search is performed on the temporary buffer, the original - buffer visiting the file is not modified." +By default, commands like `dired-mark-files-containing-regexp' will +search any buffers visiting the marked files without reverting them, +even if they were changed on disk. When this option is non-nil, such +buffers are always reverted in a temporary buffer before searching +them: the search is performed on the temporary buffer, the original +buffer visiting the file is not modified." :type 'boolean :version "26.1" :group 'dired) @@ -1019,27 +1019,27 @@ If DIRNAME is already in a Dired buffer, that buffer is used without refresh." ;;;###autoload (define-key ctl-x-4-map "d" 'dired-other-window) ;;;###autoload (defun dired-other-window (dirname &optional switches) - "\"Edit\" directory DIRNAME. Like `dired' but selects in another window." + "\"Edit\" directory DIRNAME. Like `dired' but select in another window." (interactive (dired-read-dir-and-switches "in other window ")) (switch-to-buffer-other-window (dired-noselect dirname switches))) ;;;###autoload (define-key ctl-x-5-map "d" 'dired-other-frame) ;;;###autoload (defun dired-other-frame (dirname &optional switches) - "\"Edit\" directory DIRNAME. Like `dired' but makes a new frame." + "\"Edit\" directory DIRNAME. Like `dired' but make a new frame." (interactive (dired-read-dir-and-switches "in other frame ")) (switch-to-buffer-other-frame (dired-noselect dirname switches))) ;;;###autoload (define-key tab-prefix-map "d" 'dired-other-tab) ;;;###autoload (defun dired-other-tab (dirname &optional switches) - "\"Edit\" directory DIRNAME. Like `dired' but makes a new tab." + "\"Edit\" directory DIRNAME. Like `dired' but make a new tab." (interactive (dired-read-dir-and-switches "in other tab ")) (switch-to-buffer-other-tab (dired-noselect dirname switches))) ;;;###autoload (defun dired-noselect (dir-or-list &optional switches) - "Like `dired' but returns the Dired buffer as value, does not select it." + "Like `dired' but return the Dired buffer as value, do not select it." (or dir-or-list (setq dir-or-list default-directory)) ;; This loses the distinction between "/foo/*/" and "/foo/*" that ;; some shells make: @@ -1616,7 +1616,7 @@ see `dired-use-ls-dired' for more details.") (dired-insert-set-properties content-point (point))))) (defun dired-insert-set-properties (beg end) - "Add various text properties to the lines in the region." + "Add various text properties to the lines in the region, from BEG to END." (save-excursion (goto-char beg) (while (< (point) end) @@ -2879,7 +2879,7 @@ If SUBDIRS is non-nil, also include the dired buffers of directories below DIR. The list is in reverse order of buffer creation, most recent last. As a side effect, killed dired buffers for DIR are removed from -dired-buffers." +`dired-buffers'." (setq dir (file-name-as-directory dir)) (let (result buf) (dolist (elt dired-buffers) @@ -4191,7 +4191,7 @@ The idea is to set this buffer-locally in special Dired buffers.") (defcustom dired-switches-in-mode-line nil "How to indicate `dired-actual-switches' in mode-line. Possible values: - * `nil': Indicate name-or-date sort order, if possible. + * nil: Indicate name-or-date sort order, if possible. Else show full switches. * `as-is': Show full switches. * Integer: Show only the first N chars of full switches. diff --git a/lisp/doc-view.el b/lisp/doc-view.el index a0ffcac9f80..0896bd13eb5 100644 --- a/lisp/doc-view.el +++ b/lisp/doc-view.el @@ -41,7 +41,7 @@ ;; ;; C-x C-f ~/path/to/document RET ;; -;; and the document will be converted and displayed, if your emacs supports PNG +;; and the document will be converted and displayed, if your Emacs supports PNG ;; images. With `C-c C-c' you can toggle between the rendered images ;; representation and the source text representation of the document. ;; @@ -788,7 +788,7 @@ OpenDocument format)." (doc-view-reconvert-doc))))) (defun doc-view-shrink (factor) - "Shrink the document." + "Shrink the document by FACTOR." (interactive (list doc-view-shrink-factor)) (doc-view-enlarge (/ 1.0 factor))) @@ -809,7 +809,7 @@ OpenDocument format)." FACTOR defaults to `doc-view-shrink-factor'. The actual adjustment made depends on the final component of the -key-binding used to invoke the command, with all modifiers removed: +keybinding used to invoke the command, with all modifiers removed: +, = Increase the image scale by FACTOR - Decrease the image scale by FACTOR @@ -1197,7 +1197,7 @@ Start by converting PAGES, and then the rest." (defun doc-view-current-cache-doc-pdf () "Return the name of the doc.pdf in the current cache dir. - This file exists only if the current document isn't a PDF or PS file already." +This file exists only if the current document isn't a PDF or PS file already." (expand-file-name "doc.pdf" (doc-view--current-cache-dir))) (defun doc-view-doc->txt (txt callback) diff --git a/lisp/dos-fns.el b/lisp/dos-fns.el index e0a533c637a..07c77faa23b 100644 --- a/lisp/dos-fns.el +++ b/lisp/dos-fns.el @@ -290,14 +290,14 @@ and `dos-set-register-value', which see." ;; set screen size. (defun dos-mode25 () - "Changes the number of screen rows to 25." + "Change the number of screen rows to 25." (interactive) (set-frame-size (selected-frame) 80 25)) (define-obsolete-function-alias 'mode25 'dos-mode25 "24.1") (defun dos-mode4350 () - "Changes the number of rows to 43 or 50. + "Change the number of rows to 43 or 50. Emacs always tries to set the screen height to 50 rows first. If this fails, it will try to set it to 43 rows, on the assumption that your video hardware might not support 50-line mode." diff --git a/lisp/edmacro.el b/lisp/edmacro.el index e18aad1c3f0..8ee413acd06 100644 --- a/lisp/edmacro.el +++ b/lisp/edmacro.el @@ -337,7 +337,7 @@ or nil, use a compact 80-column format." (funcall finish-hook))))) (defun edmacro-insert-key (key) - "Insert the written name of a key in the buffer." + "Insert the written name of a KEY in the buffer." (interactive "kKey to insert: ") (if (bolp) (insert (edmacro-format-keys key t) "\n") diff --git a/lisp/elec-pair.el b/lisp/elec-pair.el index d8c377a2ef5..82db8dbfc76 100644 --- a/lisp/elec-pair.el +++ b/lisp/elec-pair.el @@ -238,9 +238,9 @@ inside a comment or string." (self-insert-command 1))) (cl-defmacro electric-pair--with-uncached-syntax ((table &optional start) &rest body) - "Like `with-syntax-table', but flush the syntax-ppss cache afterwards. + "Like `with-syntax-table', but flush the `syntax-ppss' cache afterwards. Use this instead of (with-syntax-table TABLE BODY) when BODY -contains code which may update the syntax-ppss cache. This +contains code which may update the `syntax-ppss' cache. This includes calling `parse-partial-sexp' and any sexp-based movement functions when `parse-sexp-lookup-properties' is non-nil. The cache is flushed from position START, defaulting to point." diff --git a/lisp/emacs-lisp/byte-run.el b/lisp/emacs-lisp/byte-run.el index aca5dcba62c..6d698ffb6f0 100644 --- a/lisp/emacs-lisp/byte-run.el +++ b/lisp/emacs-lisp/byte-run.el @@ -422,12 +422,12 @@ was first made obsolete, for example a date or a release number." &optional docstring) "Set OBSOLETE-NAME's function definition to CURRENT-NAME and mark it obsolete. -\(define-obsolete-function-alias \\='old-fun \\='new-fun \"22.1\" \"old-fun's doc.\") +\(define-obsolete-function-alias \\='old-fun \\='new-fun \"28.1\" \"old-fun's doc.\") is equivalent to the following two lines of code: \(defalias \\='old-fun \\='new-fun \"old-fun's doc.\") -\(make-obsolete \\='old-fun \\='new-fun \"22.1\") +\(make-obsolete \\='old-fun \\='new-fun \"28.1\") WHEN should be a string indicating when the function was first made obsolete, for example a date or a release number. @@ -462,7 +462,7 @@ made obsolete, for example a date or a release number. This macro evaluates all its parameters, and both OBSOLETE-NAME and CURRENT-NAME should be symbols, so a typical usage would look like: - (define-obsolete-variable-alias 'foo-thing 'bar-thing \"27.1\") + (define-obsolete-variable-alias 'foo-thing 'bar-thing \"28.1\") This macro uses `defvaralias' and `make-obsolete-variable' (which see). See the Info node `(elisp)Variable Aliases' for more details. diff --git a/lisp/emulation/cua-base.el b/lisp/emulation/cua-base.el index 54f881bde8a..b6620499603 100644 --- a/lisp/emulation/cua-base.el +++ b/lisp/emulation/cua-base.el @@ -67,7 +67,7 @@ ;; In addition to using the shifted movement keys, you can also use ;; [C-space] to start the region and use unshifted movement keys to extend -;; it. To cancel the region, use [C-space] or [C-g]. +;; it. To cancel the region, use [C-space] or [C-g]. ;; If you prefer to use the standard Emacs cut, copy, paste, and undo ;; bindings, customize cua-enable-cua-keys to nil. @@ -116,7 +116,7 @@ ;; "register commands". ;; ;; CUA's register support is activated by providing a numeric -;; prefix argument to the C-x, C-c, and C-v commands. For example, +;; prefix argument to the C-x, C-c, and C-v commands. For example, ;; to copy the selected region to register 2, enter [M-2 C-c]. ;; Or if you have activated the keypad prefix mode, enter [kp-2 C-c]. ;; @@ -182,7 +182,7 @@ ;; If you type a normal (self-inserting) character when the rectangle is ;; active, the character is inserted on the "current side" of every line ;; of the rectangle. The "current side" is the side on which the cursor -;; is currently located. If the rectangle is only 1 column wide, +;; is currently located. If the rectangle is only 1 column wide, ;; insertion will be performed to the left when the cursor is at the ;; bottom of the rectangle. So, for example, to comment out an entire ;; paragraph like this one, just place the cursor on the first character @@ -360,7 +360,7 @@ managers, so try setting this to nil, if prefix override doesn't work." :type 'boolean) (defcustom cua-paste-pop-rotate-temporarily nil - "If non-nil, \\[cua-paste-pop] only rotates the kill-ring temporarily. + "If non-nil, \\[cua-paste-pop] only rotates the kill ring temporarily. This means that both \\[yank] and the first \\[yank-pop] in a sequence always insert the most recently killed text. Each immediately following \\[cua-paste-pop] replaces the previous text with the next older element on the `kill-ring'. @@ -1140,7 +1140,7 @@ If ARG is the atom `-', scroll upward by nearly full screen." def nil)) (defvar cua-global-keymap (make-sparse-keymap) - "Global keymap for cua-mode; users may add to this keymap.") + "Global keymap for `cua-mode'; users may add to this keymap.") (defvar cua--cua-keys-keymap (make-sparse-keymap)) (defvar cua--prefix-override-keymap (make-sparse-keymap)) diff --git a/lisp/emulation/edt-mapper.el b/lisp/emulation/edt-mapper.el index a723dbdbb90..8a42f893152 100644 --- a/lisp/emulation/edt-mapper.el +++ b/lisp/emulation/edt-mapper.el @@ -55,7 +55,7 @@ ;; Usage: -;; Simply load this file into emacs and run the function edt-mapper, +;; Simply load this file into Emacs and run the function edt-mapper, ;; using the following command. ;; emacs -q -l edt-mapper -f edt-mapper @@ -82,8 +82,8 @@ ;; Sometimes, edt-mapper will ignore a key you press, and just ;; continue to prompt for the same key. This can happen when your -;; window manager sucks up the key and doesn't pass it on to emacs, -;; or it could be an emacs bug. Either way, there's nothing that +;; window manager sucks up the key and doesn't pass it on to Emacs, +;; or it could be an Emacs bug. Either way, there's nothing that ;; edt-mapper can do about it. You must press RETURN, to skip the ;; current key and continue. Later, you and/or your local Emacs guru ;; can try to figure out why the key is being ignored. diff --git a/lisp/emulation/keypad.el b/lisp/emulation/keypad.el index 56202c7fff8..4500faae57b 100644 --- a/lisp/emulation/keypad.el +++ b/lisp/emulation/keypad.el @@ -27,7 +27,7 @@ ;; ;; With the following setup, the keypad can be used for numeric data ;; entry when NumLock is off, and to give numeric prefix arguments to -;; emacs commands, when NumLock is on. +;; Emacs commands, when NumLock is on. ;; ;; keypad-setup => Plain Numeric Keypad ;; keypad-numlock-setup => Prefix numeric args @@ -203,7 +203,7 @@ keys are bound. `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; + `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. diff --git a/lisp/emulation/viper-cmd.el b/lisp/emulation/viper-cmd.el index 728f790a962..c3b36f10aed 100644 --- a/lisp/emulation/viper-cmd.el +++ b/lisp/emulation/viper-cmd.el @@ -91,7 +91,7 @@ space return delete backspace ) - "Movement commands") + "Movement commands.") ;; define viper-movement-command-p (viper-test-com-defun viper-movement-command) @@ -487,7 +487,7 @@ (viper-change-state-to-vi)) (defun viper-set-mode-vars-for (state) - "Sets Viper minor mode variables to put Viper's state STATE in effect." + "Set Viper minor mode variables to put Viper's state STATE in effect." ;; Emacs state (setq viper-vi-minibuffer-minor-mode nil @@ -1197,7 +1197,7 @@ as a Meta key and any number of multiple escapes are allowed." ) (defsubst viper-yank-last-insertion () - "Inserts the text saved by the previous viper-save-last-insertion command." + "Insert the text saved by the previous viper-save-last-insertion command." (condition-case nil (insert viper-last-insertion) (error nil))) @@ -1500,7 +1500,7 @@ Doesn't change viper-command-ring in any way, so `.' will work as before executing this command. This command is supposed to be bound to a two-character Vi macro where the second character is a digit 0 to 9. The digit indicates which -history command to execute. `0' is equivalent to `.', `1' +history command to execute. `0' is equivalent to `.', `1' invokes the command before that, etc." (interactive) (let* ((viper-intermediate-command 'repeating-display-destructive-command) @@ -3838,7 +3838,7 @@ Null string will repeat previous search." ;; yank and pop (defsubst viper-yank (text) - "Yank TEXT silently. This works correctly with Emacs's yank-pop command." + "Yank TEXT silently. This works correctly with Emacs's `yank-pop' command." (insert text) (setq this-command 'yank)) @@ -4510,7 +4510,7 @@ One can use \\=`\\=` and \\='\\=' to temporarily jump 1 step back." (defun viper-set-expert-level (&optional dont-change-unless) - "Sets the expert level for a Viper user. + "Set the expert level for a Viper user. Can be called interactively to change (temporarily or permanently) the current expert level. diff --git a/lisp/emulation/viper-ex.el b/lisp/emulation/viper-ex.el index 55930e7e6bc..e93666956ce 100644 --- a/lisp/emulation/viper-ex.el +++ b/lisp/emulation/viper-ex.el @@ -2176,7 +2176,7 @@ Please contact your system administrator. ")))))) (goto-char beg))))) (defun ex-compile () - "Reads args from the command line, then runs make with the args. + "Read args from the command line, then run make with the args. If no args are given, then it runs the last compile command. Type `mak ' (including the space) to run make with no args." (let (args) diff --git a/lisp/emulation/viper-keym.el b/lisp/emulation/viper-keym.el index 4a9070e84be..75b627ea6a7 100644 --- a/lisp/emulation/viper-keym.el +++ b/lisp/emulation/viper-keym.el @@ -86,8 +86,8 @@ major mode in effect." "Keymap for user-defined local bindings. Useful for changing bindings such as ZZ in certain major modes. For instance, in letter-mode, one may want to bind ZZ to -mh-send-letter. In a newsreader such as gnus, tin, or rn, ZZ could be bound -to save-buffers-kill-emacs then post article, etc.") +`mh-send-letter'. In a newsreader such as gnus, tin, or rn, ZZ could be bound +to `save-buffers-kill-emacs' then post article, etc.") (put 'viper-vi-local-user-map 'permanent-local t) (defvar viper-vi-global-user-map (make-sparse-keymap) @@ -491,7 +491,7 @@ 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. Usage: - (viper-add-local-keys state \\='((key-str . func) (key-str . func)...)) " + (viper-add-local-keys state \\='((key-str . func) (key-str . func)...))" (let (map) (cond ((eq state 'vi-state) @@ -520,7 +520,7 @@ Usage: (defun viper-zap-local-keys () "Unconditionally reset Viper viper-*-local-user-map's. Rarely useful, but if you made a mistake by switching to a mode that adds -undesirable local keys, e.g., comint-mode, then this function can restore +undesirable local keys, e.g., `comint-mode', then this function can restore sanity." (interactive) (setq viper-vi-local-user-map (make-sparse-keymap) diff --git a/lisp/emulation/viper-mous.el b/lisp/emulation/viper-mous.el index 83fc5afafa5..98b123a7f49 100644 --- a/lisp/emulation/viper-mous.el +++ b/lisp/emulation/viper-mous.el @@ -116,7 +116,7 @@ considered related." (buffer-name (viper-mouse-click-window-buffer click))) (defsubst viper-mouse-click-posn (click) - "Returns position of a click." + "Return position of a click." (declare (obsolete nil "27.1")) (posn-point (event-start click))) diff --git a/lisp/emulation/viper.el b/lisp/emulation/viper.el index cce51174336..6ba265f8abf 100644 --- a/lisp/emulation/viper.el +++ b/lisp/emulation/viper.el @@ -15,7 +15,7 @@ ;; of the bug report be sent to the maintainer's email address. (defconst viper-version "3.14.2 of July 4, 2013" - "The current version of Viper") + "The current version of Viper.") ;; This file is part of GNU Emacs. @@ -516,7 +516,7 @@ If Viper is enabled, turn it off. Otherwise, turn it on." ;;;###autoload (defun viper-mode () - "Turn on Viper emulation of Vi in Emacs. See Info node `(viper)Top'." + "Turn on Viper emulation of Vi in Emacs. See Info node `(viper)Top'." (interactive) (if (not noninteractive) (progn diff --git a/lisp/epa-hook.el b/lisp/epa-hook.el index 9ad952c6813..99a432c236e 100644 --- a/lisp/epa-hook.el +++ b/lisp/epa-hook.el @@ -24,7 +24,7 @@ ;;; Code: (defgroup epa-file nil - "The EasyPG Assistant hooks for transparent file encryption" + "The EasyPG Assistant hooks for transparent file encryption." :version "23.1" :group 'epa) diff --git a/lisp/epa.el b/lisp/epa.el index 2698b39ffe3..ed1dae3e8ae 100644 --- a/lisp/epa.el +++ b/lisp/epa.el @@ -30,7 +30,7 @@ ;;; Options (defgroup epa nil - "The EasyPG Assistant" + "The EasyPG Assistant." :version "23.1" :link '(custom-manual "(epa) Top") :group 'epg) diff --git a/lisp/erc/erc-autoaway.el b/lisp/erc/erc-autoaway.el index 1a13aa95cd2..bbab37fd5d5 100644 --- a/lisp/erc/erc-autoaway.el +++ b/lisp/erc/erc-autoaway.el @@ -183,7 +183,7 @@ See `erc-auto-discard-away'." (defcustom erc-autoaway-idle-seconds 1800 "Number of seconds after which ERC will set you automatically away. -If you are changing this variable using lisp instead of customizing it, +If you are changing this variable using Lisp instead of customizing it, you have to run `erc-autoaway-reestablish-idletimer' afterwards." :set (lambda (sym val) (set-default sym val) diff --git a/lisp/erc/erc-button.el b/lisp/erc/erc-button.el index fc72f324eb9..4e9547dfde1 100644 --- a/lisp/erc/erc-button.el +++ b/lisp/erc/erc-button.el @@ -24,7 +24,7 @@ ;;; Commentary: -;; Heavily borrowed from gnus-art.el. Thanks to the original authors. +;; Heavily borrowed from gnus-art.el. Thanks to the original authors. ;; This buttonizes nicks and other stuff to make it all clickable. ;; To enable, add to your init file: ;; (require 'erc-button) @@ -165,7 +165,7 @@ REGEXP is the string matching text around the button or a symbol BUTTON is the number of the regexp grouping actually matching the button. This is ignored if REGEXP is \\='nicknames. -FORM is a lisp expression which must eval to true for the button to +FORM is a Lisp expression which must eval to true for the button to be added. CALLBACK is the function to call when the user push this button. diff --git a/lisp/erc/erc-ibuffer.el b/lisp/erc/erc-ibuffer.el index 31e59a6d3e4..95eab040449 100644 --- a/lisp/erc/erc-ibuffer.el +++ b/lisp/erc/erc-ibuffer.el @@ -38,17 +38,16 @@ :group 'erc) (defcustom erc-ibuffer-keyword-char ?k - "Char used to indicate a channel which had keyword traffic lately (hidden)." + "Char indicating a channel which had keyword traffic lately (hidden)." :type 'character) (defcustom erc-ibuffer-pal-char ?p - "Char used to indicate a channel which had pal traffic lately (hidden)." + "Char indicating a channel which had pal traffic lately (hidden)." :type 'character) (defcustom erc-ibuffer-fool-char ?f - "Char used to indicate a channel which had fool traffic lately (hidden)." + "Char indicating a channel which had fool traffic lately (hidden)." :type 'character) (defcustom erc-ibuffer-dangerous-host-char ?d - "Char used to indicate a channel which had dangerous-host traffic lately -\(hidden)." + "Char indicating a channel which had dangerous-host traffic lately (hidden)." :type 'character) (define-ibuffer-filter erc-server diff --git a/lisp/erc/erc-match.el b/lisp/erc/erc-match.el index 43fbca3e666..fb50e84f655 100644 --- a/lisp/erc/erc-match.el +++ b/lisp/erc/erc-match.el @@ -24,7 +24,7 @@ ;;; Commentary: -;; This file includes stuff to work with pattern matching in ERC. If +;; This file includes stuff to work with pattern matching in ERC. If ;; you were used to customizing erc-fools, erc-keywords, erc-pals, ;; erc-dangerous-hosts and the like, this file contains these ;; customizable variables. diff --git a/lisp/erc/erc-netsplit.el b/lisp/erc/erc-netsplit.el index 9cfb947003c..994f2d07c30 100644 --- a/lisp/erc/erc-netsplit.el +++ b/lisp/erc/erc-netsplit.el @@ -52,7 +52,7 @@ netsplits, so that it can filter the JOIN messages on a netjoin too." (remove-hook 'erc-timer-hook #'erc-netsplit-timer))) (defcustom erc-netsplit-show-server-mode-changes-flag nil - "Set to t to enable display of server mode changes." + "Non-nil means to enable display of server mode changes." :type 'boolean) (defcustom erc-netsplit-debug nil @@ -61,8 +61,7 @@ netsplits, so that it can filter the JOIN messages on a netjoin too." (defcustom erc-netsplit-regexp "^[^ @!\"\n]+\\.[^ @!\n]+ [^ @!\n]+\\.[^ @!\"\n]+$" - "This regular expression should match quit reasons produced -by netsplits." + "This regular expression should match quit reasons produced by netsplits." :type 'regexp) (defcustom erc-netsplit-hook nil diff --git a/lisp/erc/erc-networks.el b/lisp/erc/erc-networks.el index ca0e90e984e..1c7742afd21 100644 --- a/lisp/erc/erc-networks.el +++ b/lisp/erc/erc-networks.el @@ -45,7 +45,7 @@ ;; Variables (defgroup erc-networks nil - "IRC Networks" + "IRC Networks." :group 'erc) (defcustom erc-server-alist @@ -720,7 +720,7 @@ NET is a symbol naming that IRC network and MATCHER is used to find a corresponding network to a server while connected to it. If it is regexp, it's used to match against `erc-server-announced-name'. It can also be a function (predicate). - Then it is executed with the server buffer as current-buffer." + Then it is executed with the server buffer as current buffer." :type '(repeat (list :tag "Network" (symbol :tag "Network name") diff --git a/lisp/erc/erc-pcomplete.el b/lisp/erc/erc-pcomplete.el index 8ea37c7f290..43330755a85 100644 --- a/lisp/erc/erc-pcomplete.el +++ b/lisp/erc/erc-pcomplete.el @@ -44,7 +44,7 @@ (require 'time-date) (defgroup erc-pcomplete nil - "Programmable completion for ERC" + "Programmable completion for ERC." :group 'erc) (defcustom erc-pcomplete-nick-postfix ":" diff --git a/lisp/erc/erc-replace.el b/lisp/erc/erc-replace.el index 3f69c4cb9cc..90c0ee6f8a4 100644 --- a/lisp/erc/erc-replace.el +++ b/lisp/erc/erc-replace.el @@ -37,7 +37,7 @@ (require 'erc) (defgroup erc-replace nil - "Replace text from incoming messages" + "Replace text from incoming messages." :group 'erc) (defcustom erc-replace-alist nil diff --git a/lisp/erc/erc-ring.el b/lisp/erc/erc-ring.el index 666fd585926..52285a8343a 100644 --- a/lisp/erc/erc-ring.el +++ b/lisp/erc/erc-ring.el @@ -79,7 +79,7 @@ STATE-OR-STRING should be a string or an erc-input object." (setq erc-input-ring-index nil)) (defun erc-clear-input-ring () - "Remove all entries from the input ring, then call garbage-collect. + "Remove all entries from the input ring, then call `garbage-collect'. You might use this for security purposes if you have typed a command containing a password." (interactive) diff --git a/lisp/erc/erc-sound.el b/lisp/erc/erc-sound.el index 92759d206a3..e835c45af88 100644 --- a/lisp/erc/erc-sound.el +++ b/lisp/erc/erc-sound.el @@ -128,8 +128,9 @@ See also `play-sound-file'." (erc-log (format "Playing sound file %S" filepath)))) (defun erc-toggle-sound (&optional arg) - "Toggles playing sounds on and off. With positive argument, - turns them on. With any other argument turns sounds off." + "Toggles playing sounds on and off. +With positive argument, turns them on. With any other argument +turns sounds off." (interactive "P") (cond ((and (numberp arg) (> arg 0)) (setq erc-play-sound t)) diff --git a/lisp/erc/erc-spelling.el b/lisp/erc/erc-spelling.el index 950a821e3c4..ddfaafb0483 100644 --- a/lisp/erc/erc-spelling.el +++ b/lisp/erc/erc-spelling.el @@ -24,7 +24,7 @@ ;;; Commentary: -;; This is an ERC module to enable flyspell mode in ERC buffers. This +;; This is an ERC module to enable flyspell mode in ERC buffers. This ;; ensures correct behavior of flyspell, and even sets up a ;; channel-local dictionary if so required. diff --git a/lisp/erc/erc-status-sidebar.el b/lisp/erc/erc-status-sidebar.el index a75a74bb6fd..a6ad856bfd7 100644 --- a/lisp/erc/erc-status-sidebar.el +++ b/lisp/erc/erc-status-sidebar.el @@ -274,7 +274,7 @@ to the `window-configuration-change-hook'." (apply #'window-preserve-size (selected-window) t t nil)))) (define-derived-mode erc-status-sidebar-mode special-mode "ERC Sidebar" - "Major mode for ERC status sidebar" + "Major mode for ERC status sidebar." ;; Don't scroll the buffer horizontally, if a channel name is ;; obscured then the window can be resized. (setq-local auto-hscroll-mode nil) diff --git a/lisp/erc/erc-track.el b/lisp/erc/erc-track.el index 2582a5039a6..eb2a9712ac1 100644 --- a/lisp/erc/erc-track.el +++ b/lisp/erc/erc-track.el @@ -546,8 +546,7 @@ keybindings will not do anything useful." (erc-track-minor-mode -1))))) (defcustom erc-track-when-inactive nil - "Enable channel tracking even for visible buffers, if you are -inactive." + "Enable channel tracking even for visible buffers, if you are inactive." :type 'boolean :set (lambda (sym val) (if erc-track-mode @@ -598,9 +597,10 @@ only consider active buffers visible.") (erc-modified-channels-update))) (defvar erc-modified-channels-update-inside nil - "Variable to prevent running `erc-modified-channels-update' multiple -times. Without it, you cannot debug `erc-modified-channels-display', -because the debugger also causes changes to the window-configuration.") + "Variable to prevent running `erc-modified-channels-update' multiple times. +Without it, you cannot debug `erc-modified-channels-display', +because the debugger also causes changes to the +window-configuration.") (defun erc-modified-channels-update (&rest _args) "This function updates the information in `erc-modified-channels-alist' @@ -630,7 +630,7 @@ ARGS are ignored." "The face to use when mouse is over channel names in the mode line.") (defun erc-make-mode-line-buffer-name (string buffer &optional faces count) - "Returns a button that switches to BUFFER when clicked. + "Return a button that switches to BUFFER when clicked. STRING is the string in the button. It is possibly suffixed with the number of unread messages, according to variables `erc-track-showcount' and `erc-track-showcount-string'. diff --git a/lisp/erc/erc-truncate.el b/lisp/erc/erc-truncate.el index ff33fbc5570..2c4002f0ee0 100644 --- a/lisp/erc/erc-truncate.el +++ b/lisp/erc/erc-truncate.el @@ -25,8 +25,8 @@ ;;; Commentary: ;; This implements buffer truncation (and optional log file writing -;; support for the Emacs IRC client. Use `erc-truncate-mode' to switch -;; on. Use `erc-enable-logging' to enable logging of the stuff which +;; support for the Emacs IRC client. Use `erc-truncate-mode' to switch +;; on. Use `erc-enable-logging' to enable logging of the stuff which ;; is getting truncated. ;;; Code: @@ -34,7 +34,7 @@ (require 'erc) (defgroup erc-truncate nil - "Truncate buffers when they reach a certain size" + "Truncate buffers when they reach a certain size." :group 'erc) (defcustom erc-max-buffer-size 30000 diff --git a/lisp/erc/erc-xdcc.el b/lisp/erc/erc-xdcc.el index e1b9f0de3a7..c17eb59da31 100644 --- a/lisp/erc/erc-xdcc.el +++ b/lisp/erc/erc-xdcc.el @@ -68,7 +68,7 @@ being evaluated and should return strings." ;;;###autoload (defun erc-xdcc-add-file (file) - "Add a file to `erc-xdcc-files'." + "Add FILE to `erc-xdcc-files'." (interactive "fFilename to add to XDCC: ") (if (file-exists-p file) (add-to-list 'erc-xdcc-files file))) diff --git a/lisp/erc/erc.el b/lisp/erc/erc.el index 60168d42f94..d08796a78d8 100644 --- a/lisp/erc/erc.el +++ b/lisp/erc/erc.el @@ -80,32 +80,32 @@ :group 'applications) (defgroup erc-buffers nil - "Creating new ERC buffers" + "Creating new ERC buffers." :group 'erc) (defgroup erc-display nil - "Settings for how various things are displayed" + "Settings for how various things are displayed." :group 'erc) (defgroup erc-mode-line-and-header nil - "Displaying information in the mode-line and header" + "Displaying information in the mode-line and header." :group 'erc-display) (defgroup erc-ignore nil - "Ignoring certain messages" + "Ignoring certain messages." :group 'erc) (defgroup erc-lurker nil - "Hide specified message types sent by lurkers" + "Hide specified message types sent by lurkers." :version "24.3" :group 'erc-ignore) (defgroup erc-query nil - "Using separate buffers for private discussions" + "Using separate buffers for private discussions." :group 'erc) (defgroup erc-quit-and-part nil - "Quitting and parting channels" + "Quitting and parting channels." :group 'erc) (defgroup erc-paranoia nil @@ -113,7 +113,7 @@ :group 'erc) (defgroup erc-scripts nil - "Running scripts at startup and with /LOAD" + "Running scripts at startup and with /LOAD." :group 'erc) (require 'erc-backend) @@ -280,9 +280,9 @@ indicate it has handled the input." :type 'hook) (defcustom erc-join-hook nil - "Hook run when we join a channel. Hook functions are called -without arguments, with the current buffer set to the buffer of -the new channel. + "Hook run when we join a channel. +Hook functions are called without arguments, with the current +buffer set to the buffer of the new channel. See also `erc-server-JOIN-functions', `erc-part-hook'." :group 'erc-hooks @@ -533,10 +533,10 @@ Removes all users in the current channel. This is called by (erc-channel-user-voice (cdr cdata)))))))) (defun erc-get-channel-user-list () - "Return a list of users in the current channel. Each element -of the list is of the form (USER . CHANNEL-DATA), where USER is -an erc-server-user struct, and CHANNEL-DATA is either nil or an -erc-channel-user struct. + "Return a list of users in the current channel. +Each element of the list is of the form (USER . CHANNEL-DATA), +where USER is an erc-server-user struct, and CHANNEL-DATA is +either nil or an erc-channel-user struct. See also: `erc-sort-channel-users-by-activity'." (let (users) @@ -816,7 +816,7 @@ set if some hacker is trying to flood you away." (defcustom erc-system-name nil "Use this as the name of your system. -If nil, ERC will call `system-name' to get this information." +If nil, ERC will call function `system-name' to get this information." :group 'erc :type '(choice (const :tag "Default system name" nil) string)) @@ -1487,8 +1487,8 @@ Defaults to the server buffer." "IRC port to use if it cannot be detected otherwise.") (defconst erc-default-port-tls 6697 - "IRC port to use for encrypted connections if it cannot be - detected otherwise.") + "IRC port to use for encrypted connections if it cannot be \ +detected otherwise.") (defcustom erc-join-buffer 'buffer "Determines how to display a newly created IRC buffer. @@ -3741,7 +3741,7 @@ the message given by REASON." (condition-case nil (erc :server server :nick (erc-current-nick)) (error - (erc-error "Cannot find host %s." server))) + (erc-error "Cannot find host: `%s'" server))) t) (put 'erc-cmd-SERVER 'process-not-needed t) @@ -4490,7 +4490,7 @@ also `erc-format-nick-function'." (propertize prefix 'font-lock-face 'erc-default-face)))) (defun erc-echo-notice-in-default-buffer (s parsed buffer _sender) - "Echos a private notice in the default buffer, namely the + "Echo a private notice in the default buffer, namely the target buffer specified by BUFFER, or there is no target buffer, the server buffer. This function is designed to be added to either `erc-echo-notice-hook' or `erc-echo-notice-always-hook', @@ -4499,30 +4499,32 @@ and always returns t." t) (defun erc-echo-notice-in-target-buffer (s parsed buffer _sender) - "Echos a private notice in BUFFER, if BUFFER is non-nil. This -function is designed to be added to either `erc-echo-notice-hook' -or `erc-echo-notice-always-hook', and returns non-nil if BUFFER -is non-nil." + "Echo a private notice in BUFFER, if BUFFER is non-nil. +This function is designed to be added to either +`erc-echo-notice-hook' or `erc-echo-notice-always-hook', and +returns non-nil if BUFFER is non-nil." (if buffer (progn (erc-display-message parsed nil buffer s) t) nil)) (defun erc-echo-notice-in-minibuffer (s _parsed _buffer _sender) - "Echos a private notice in the minibuffer. This function is -designed to be added to either `erc-echo-notice-hook' or -`erc-echo-notice-always-hook', and always returns t." + "Echo a private notice in the minibuffer. +This function is designed to be added to either +`erc-echo-notice-hook' or `erc-echo-notice-always-hook', and +always returns t." (message "%s" (concat "NOTICE: " s)) t) (defun erc-echo-notice-in-server-buffer (s parsed _buffer _sender) - "Echos a private notice in the server buffer. This function is -designed to be added to either `erc-echo-notice-hook' or -`erc-echo-notice-always-hook', and always returns t." + "Echo a private notice in the server buffer. +This function is designed to be added to either +`erc-echo-notice-hook' or `erc-echo-notice-always-hook', and +always returns t." (erc-display-message parsed nil nil s) t) (defun erc-echo-notice-in-active-non-server-buffer (s parsed _buffer _sender) - "Echos a private notice in the active buffer if the active + "Echo a private notice in the active buffer if the active buffer is not the server buffer. This function is designed to be added to either `erc-echo-notice-hook' or `erc-echo-notice-always-hook', and returns non-nil if the active @@ -4532,14 +4534,15 @@ buffer is not the server buffer." nil)) (defun erc-echo-notice-in-active-buffer (s parsed _buffer _sender) - "Echos a private notice in the active buffer. This function is -designed to be added to either `erc-echo-notice-hook' or -`erc-echo-notice-always-hook', and always returns t." + "Echo a private notice in the active buffer. +This function is designed to be added to either +`erc-echo-notice-hook' or `erc-echo-notice-always-hook', and +always returns t." (erc-display-message parsed nil 'active s) t) (defun erc-echo-notice-in-user-buffers (s parsed _buffer sender) - "Echos a private notice in all of the buffers for which SENDER + "Echo a private notice in all of the buffers for which SENDER is a member. This function is designed to be added to either `erc-echo-notice-hook' or `erc-echo-notice-always-hook', and returns non-nil if there is at least one buffer for which the @@ -4553,7 +4556,7 @@ See also: `erc-echo-notice-in-first-user-buffer', nil))) (defun erc-echo-notice-in-user-and-target-buffers (s parsed buffer sender) - "Echos a private notice in BUFFER and in all of the buffers for + "Echo a private notice in BUFFER and in all of the buffers for which SENDER is a member. This function is designed to be added to either `erc-echo-notice-hook' or `erc-echo-notice-always-hook', and returns non-nil if there is @@ -4569,7 +4572,7 @@ See also: `erc-echo-notice-in-user-buffers', nil))) (defun erc-echo-notice-in-first-user-buffer (s parsed _buffer sender) - "Echos a private notice in one of the buffers for which SENDER + "Echo a private notice in one of the buffers for which SENDER is a member. This function is designed to be added to either `erc-echo-notice-hook' or `erc-echo-notice-always-hook', and returns non-nil if there is at least one buffer for which the @@ -5030,10 +5033,11 @@ See also: `erc-update-user'." (defun erc-update-user (user &optional new-nick host login full-name info) - "Update user info for USER. USER must be an erc-server-user -struct. Any of NEW-NICK, HOST, LOGIN, FULL-NAME, INFO which are -non-nil and not equal to the existing values for USER are used to -replace the stored values in USER. + "Update user info for USER. +USER must be an erc-server-user struct. Any of NEW-NICK, HOST, +LOGIN, FULL-NAME, INFO which are non-nil and not equal to the +existing values for USER are used to replace the stored values in +USER. If, and only if, a change is made, `erc-channel-members-changed-hook' is run for each channel for @@ -5570,9 +5574,9 @@ submitted line to be intentional." string insertp sendp) (defun erc-send-input (input) - "Treat INPUT as typed in by the user. It is assumed that the input -and the prompt is already deleted. -This returns non-nil only if we actually send anything." + "Treat INPUT as typed in by the user. +It is assumed that the input and the prompt is already deleted. +Return non-nil only if we actually send anything." ;; Handle different kinds of inputs (cond ;; Ignore empty input diff --git a/lisp/eshell/esh-io.el b/lisp/eshell/esh-io.el index 0e6121031dc..c2471912ab8 100644 --- a/lisp/eshell/esh-io.el +++ b/lisp/eshell/esh-io.el @@ -94,7 +94,7 @@ though they were files." Currently this is standard input, output and error. But even all of these Emacs does not currently support with asynchronous processes \(which is what eshell uses so that you can continue doing work in -other buffers) ." +other buffers)." :type 'integer :group 'eshell-io) diff --git a/lisp/expand.el b/lisp/expand.el index 1b722014f89..deeec8c59dc 100644 --- a/lisp/expand.el +++ b/lisp/expand.el @@ -88,7 +88,7 @@ ;;; Samples: -(define-skeleton expand-c-for-skeleton "For loop skeleton" +(define-skeleton expand-c-for-skeleton "For loop skeleton." "Loop var: " "for(" str _ @ "=0; " str @ "; " str @ ") {" \n @ _ \n diff --git a/lisp/face-remap.el b/lisp/face-remap.el index 5914ee4a202..c84742be5a2 100644 --- a/lisp/face-remap.el +++ b/lisp/face-remap.el @@ -23,7 +23,6 @@ ;;; Commentary: -;; ;; This file defines some simple operations that can be used for ;; maintaining the `face-remapping-alist' in a cooperative way. This is ;; especially important for the `default' face. @@ -52,8 +51,6 @@ ;; mode setting face remappings, e.g., of the default face. ;; ;; All modifications cause face-remapping-alist to be made buffer-local. -;; - ;;; Code: @@ -218,13 +215,13 @@ Each positive or negative step scales the default face height by this amount." :version "23.1") (defvar-local text-scale-mode-remapping nil - "Current remapping cookie for text-scale-mode.") + "Current remapping cookie for `text-scale-mode'.") (defvar-local text-scale-mode-lighter "+0" - "Lighter displayed for text-scale-mode in mode-line minor-mode list.") + "Lighter displayed for `text-scale-mode' in mode-line minor-mode list.") (defvar-local text-scale-mode-amount 0 - "Number of steps that text-scale-mode will increase/decrease text height.") + "Number of steps that `text-scale-mode' will increase/decrease text height.") (defvar-local text-scale-remap-header-line nil "If non-nil, text scaling may change font size of header lines too.") @@ -352,7 +349,7 @@ See `text-scale-increase' for more details." INC may be passed as a numeric prefix argument. The actual adjustment made depends on the final component of the -key-binding used to invoke the command, with all modifiers removed: +keybinding used to invoke the command, with all modifiers removed: +, = Increase the height of the default face by one step - Decrease the height of the default face by one step diff --git a/lisp/ffap.el b/lisp/ffap.el index 84dcc04a712..b6e419b2d67 100644 --- a/lisp/ffap.el +++ b/lisp/ffap.el @@ -1114,7 +1114,7 @@ like)." (defun ffap-search-backward-file-end (&optional dir-separator end) "Search backward position point where file would probably end. -Optional DIR-SEPARATOR defaults to \"/\". The search maximum is +Optional DIR-SEPARATOR defaults to \"/\". The search maximum is `line-end-position' or optional END point. Suppose the cursor is somewhere that might be near end of file, @@ -1190,7 +1190,7 @@ Call `ffap-search-backward-file-end' to refine the ending point." (defun ffap-dir-separator-near-point () "Search backward and forward for closest slash or backlash in line. -Return string slash or backslash. Point is moved to closest position." +Return string slash or backslash. Point is moved to closest position." (let ((point (point)) str pos) (when (looking-at ".*?/") diff --git a/lisp/filenotify.el b/lisp/filenotify.el index 4fc7f0a8ec0..a0c37582386 100644 --- a/lisp/filenotify.el +++ b/lisp/filenotify.el @@ -19,7 +19,7 @@ ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs. If not, see . -;;; Commentary +;;; Commentary: ;; This package is an abstraction layer from the different low-level ;; file notification packages `inotify', `kqueue', `gfilenotify' and diff --git a/lisp/files.el b/lisp/files.el index 3055226ba27..3a397f812ec 100644 --- a/lisp/files.el +++ b/lisp/files.el @@ -4432,8 +4432,8 @@ variables will override modes." (t -2)))) (defun dir-locals--sort-variables (variables) - "Sorts VARIABLES so that applying them in order has the right effect. -The variables are compared by dir-locals--get-sort-score. + "Sort VARIABLES so that applying them in order has the right effect. +The variables are compared by `dir-locals--get-sort-score'. Directory entries are then recursively sorted using the same criteria." (setq variables (sort variables diff --git a/lisp/filesets.el b/lisp/filesets.el index d138675066c..63f0e8ba3ff 100644 --- a/lisp/filesets.el +++ b/lisp/filesets.el @@ -607,7 +607,7 @@ the filename." (:ignore-on-read-text t) ;; (:constraintp ,pic-cmd) )))) - "Association list of file patterns and external viewers for use with + "Alist of file patterns and external viewers for use with `filesets-find-or-display-file'. Has the form ((FILE-PATTERN VIEWER PROPERTIES) ...), VIEWER being either a diff --git a/lisp/find-file.el b/lisp/find-file.el index 4fd4f4e06b8..4d520c01cc3 100644 --- a/lisp/find-file.el +++ b/lisp/find-file.el @@ -32,7 +32,7 @@ ;; ;; Many people maintain their include file in a directory separate to their ;; src directory, and very often you may be editing a file and have a need to -;; visit the "other file". This package searches through a set of directories +;; visit the "other file". This package searches through a set of directories ;; to find that file. ;; ;; THE "OTHER FILE", or "corresponding file", generally has the same basename, @@ -44,14 +44,14 @@ ;; ;; If the current file has a .cc extension, ff-find-other-file will attempt ;; to look for a .hh file, and then a .h file in some directory as described -;; below. The mechanism here is to replace the matched part of the original +;; below. The mechanism here is to replace the matched part of the original ;; filename with each of the corresponding extensions in turn. ;; ;; Alternatively, there are situations where the filename of the other file -;; cannot be determined easily with regexps. For example, a .c file may +;; cannot be determined easily with regexps. For example, a .c file may ;; have two corresponding .h files, for its public and private parts, or ;; the filename for the .c file contains part of the pathname of the .h -;; file, as between src/fooZap.cc and include/FOO/zap.hh. In that case, the +;; file, as between src/fooZap.cc and include/FOO/zap.hh. In that case, the ;; format above can be changed to include a function to be called when the ;; current file matches the regexp: ;; @@ -59,7 +59,7 @@ ;; ("\\.hh\\'" hh-function)) ;; ;; These functions must return a list consisting of the possible names of the -;; corresponding file, with or without path. There is no real need for more +;; corresponding file, with or without path. There is no real need for more ;; than one function, and one could imagine the following value for cc-other- ;; file-alist: ;; @@ -78,13 +78,13 @@ ;; ;; This means that the corresponding file will be searched for first in ;; the current directory, then in ../../src, then in one of the directories -;; under ../include, and so on. The star is _not_ a general wildcard +;; under ../include, and so on. The star is _not_ a general wildcard ;; character: it just indicates that the subdirectories of this directory -;; must each be searched in turn. Environment variables will be expanded in +;; must each be searched in turn. Environment variables will be expanded in ;; the ff-search-directories variable. ;; ;; If the point is on a #include line, the file to be #included is searched -;; for in the same manner. This can be disabled with the ff-ignore-include +;; for in the same manner. This can be disabled with the ff-ignore-include ;; variable, or by calling ff-get-other-file instead of ff-find-other-file. ;; ;; If the file was not found, ff-find-other-file will prompt you for where diff --git a/lisp/find-lisp.el b/lisp/find-lisp.el index 2f432936033..6062bd26432 100644 --- a/lisp/find-lisp.el +++ b/lisp/find-lisp.el @@ -24,21 +24,21 @@ ;;; Commentary: ;; ;; This is a very generalized form of find; it basically implements a -;; recursive directory descent. The conditions which bound the search +;; recursive directory descent. The conditions which bound the search ;; are expressed as predicates, and I have not addressed the question ;; of how to wrap up the common chores that find does in a simpler ;; format than writing code for all the various predicates. ;; ;; Some random thoughts are to express simple queries directly with ;; user-level functions, and perhaps use some kind of forms interface -;; for medium-level queries. Really complicated queries can be +;; for medium-level queries. Really complicated queries can be ;; expressed in Lisp. ;; ;;; Todo ;; ;; It would be nice if we could sort the results without running the find -;; again. Maybe that could work by storing the original file attributes? +;; again. Maybe that could work by storing the original file attributes? ;;; Code: diff --git a/lisp/font-lock.el b/lisp/font-lock.el index c00a62a1607..a4ab897f6f2 100644 --- a/lisp/font-lock.el +++ b/lisp/font-lock.el @@ -697,7 +697,7 @@ comments, and to fontify `and', `or' and `not' words as keywords. The above procedure will only add the keywords for C mode, not for modes derived from C mode. To add them for derived modes too, -pass nil for MODE and add the call to c-mode-hook. +pass nil for MODE and add the call to `c-mode-hook'. For example: @@ -1039,7 +1039,7 @@ The function is given three parameters, the standard BEG, END, and OLD-LEN from `after-change-functions'. It should return either a cons of the beginning and end buffer positions \(in that order) of the region to refontify, or nil \(which directs the caller to fontify a default region). -This function should preserve the match-data. +This function should preserve the match data. The region it returns may start or end in the middle of a line.") (defun font-lock-fontify-buffer (&optional interactively) @@ -1103,7 +1103,7 @@ Called with two arguments BEG and END.") (defun font-lock-debug-fontify () "Reinitialize the font-lock machinery and (re-)fontify the buffer. This functions is a convenience functions when developing font -locking for a mode, and is not meant to be called from lisp functions." +locking for a mode, and is not meant to be called from Lisp functions." (declare (interactive-only t)) (interactive) ;; Make font-lock recalculate all the mode-specific data. @@ -1124,7 +1124,7 @@ portion of the buffer." (or beg (point-min)) (or end (point-max))))) (defun font-lock-update (&optional arg) - "Updates the syntax highlighting in this buffer. + "Update the syntax highlighting in this buffer. Refontify the accessible portion of this buffer, or enable Font Lock mode in this buffer if it is currently disabled. With prefix ARG, toggle Font Lock mode." @@ -2341,7 +2341,7 @@ This should be an integer. Used in `cpp-font-lock-keywords'.") "Font lock keywords for C preprocessor directives. `c-mode', `c++-mode' and `objc-mode' have their own font lock keywords for C preprocessor directives. This definition is for the other modes -in which C preprocessor directives are used. e.g. `asm-mode' and +in which C preprocessor directives are used, e.g. `asm-mode' and `ld-script-mode'.") (provide 'font-lock) diff --git a/lisp/forms.el b/lisp/forms.el index 46f4df9b6c4..e1de0111336 100644 --- a/lisp/forms.el +++ b/lisp/forms.el @@ -88,7 +88,7 @@ ;; constructed. The current fields are available to the function ;; in the variable `forms-fields', they should *NOT* be modified. ;; -;; - a lisp symbol, that must evaluate to one of the above. +;; - a Lisp symbol, that must evaluate to one of the above. ;; ;; Optional variables which may be set in the control file: ;; @@ -357,7 +357,7 @@ This variable is for use by the filter routines only. The contents may NOT be modified.") (defcustom forms-use-text-properties t - "Non-nil means to use text properties. " + "Non-nil means to use text properties." :type 'boolean) (defcustom forms-insert-after nil @@ -376,7 +376,7 @@ Also, initial position is at last record." ;;; Internal variables. (defvar forms--file-buffer nil - "Buffer which holds the file data") + "Buffer which holds the file data.") (defvar forms--total-records 0 "Total number of records in the data file.") @@ -410,7 +410,7 @@ Also, initial position is at last record." "Forms parser routine.") (defvar-local forms--mode-setup nil - "To keep track of forms-mode being set-up.") + "To keep track of `forms-mode' being set-up.") (defvar forms--dynamic-text nil "Array that holds dynamic texts to insert between fields.") @@ -453,8 +453,7 @@ Commands: Equivalent keys in read-only mode: C-c C-p forms-prev-record p C-c C-r forms-search-reverse r C-c C-s forms-search-forward s - C-c C-x forms-exit x -" + C-c C-x forms-exit x" (interactive) ;; This is not a simple major mode, as usual. Therefore, forms-mode @@ -1392,8 +1391,7 @@ Commands: Equivalent keys in read-only mode: (define-key map [prior] #'forms-prev-record) (define-key map [begin] #'forms-first-record) (define-key map [last] #'forms-last-record) - (define-key map [backtab] #'forms-prev-field) - ) + (define-key map [backtab] #'forms-prev-field)) ;;; Changed functions @@ -1435,8 +1433,8 @@ Commands: Equivalent keys in read-only mode: " \\[describe-mode]:help")))) (defun forms--trans (subj arg rep) - "Translate in SUBJ all chars ARG into char REP. ARG and REP should - be single-char strings." + "Translate in SUBJ all chars ARG into char REP. +ARG and REP should be single-char strings." (let ((i 0) (re (regexp-quote arg)) (k (string-to-char rep))) diff --git a/lisp/gnus/gnus-agent.el b/lisp/gnus/gnus-agent.el index cbe3505cd10..961965d9284 100644 --- a/lisp/gnus/gnus-agent.el +++ b/lisp/gnus/gnus-agent.el @@ -161,7 +161,7 @@ enable expiration per categories, topics, and groups." (defcustom gnus-agent-expire-unagentized-dirs t "Whether expiration should expire in unagentized directories. -Have gnus-agent-expire scan the directories under +Have `gnus-agent-expire' scan the directories under \(gnus-agent-directory) for groups that are no longer agentized. When found, offer to remove them." :version "22.1" @@ -622,7 +622,7 @@ manipulated as follows: The gnus-agentize function is now called internally by gnus when gnus-agent is set. If you wish to avoid calling gnus-agentize, -customize gnus-agent to nil. +customize `gnus-agent' to nil. This will modify the `gnus-setup-news-hook', and `message-send-mail-real-function' variables, and install the Gnus agent @@ -1703,8 +1703,8 @@ and that there are no duplicates." (defun gnus-agent-flush-server (&optional server-or-method) "Flush all agent index files for every subscribed group within - the given SERVER-OR-METHOD. When called with nil, the current - value of gnus-command-method identifies the server." +the given SERVER-OR-METHOD. When called with nil, the current +value of gnus-command-method identifies the server." (let* ((gnus-command-method (if server-or-method (gnus-server-to-method server-or-method) gnus-command-method)) @@ -2153,8 +2153,9 @@ doesn't exist, to valid the overview buffer." (defvar gnus-agent-file-loading-local nil) (defun gnus-agent-load-local (&optional method) - "Load the METHOD'S local file. The local file contains min/max -article counts for each of the method's subscribed groups." + "Load the METHOD'S local file. +The local file contains min/max article counts for each of the +method's subscribed groups." (let ((gnus-command-method (or method gnus-command-method))) (when (or (null gnus-agent-article-local-times) (zerop gnus-agent-article-local-times) @@ -2171,9 +2172,9 @@ article counts for each of the method's subscribed groups." gnus-agent-article-local)) (defun gnus-agent-read-and-cache-local (file) - "Load and read FILE then bind its contents to -gnus-agent-article-local. If that variable had `dirty' (also known as -modified) original contents, they are first saved to their own file." + "Load and read FILE then bind its contents to `gnus-agent-article-local'. +If that variable had `dirty' (also known as modified) original +contents, they are first saved to their own file." (if (and gnus-agent-article-local (gethash "+dirty" gnus-agent-article-local)) (gnus-agent-save-local)) @@ -2224,7 +2225,7 @@ modified) original contents, they are first saved to their own file." hashtb)) (defun gnus-agent-save-local (&optional force) - "Save gnus-agent-article-local under it method's agent.lib directory." + "Save `gnus-agent-article-local' under it method's agent.lib directory." (let ((hashtb gnus-agent-article-local)) (when (and hashtb (or force (gethash "+dirty" hashtb))) diff --git a/lisp/gnus/gnus-art.el b/lisp/gnus/gnus-art.el index c4fa1e960b6..7076dbedf2e 100644 --- a/lisp/gnus/gnus-art.el +++ b/lisp/gnus/gnus-art.el @@ -610,17 +610,17 @@ The recommended coding systems are `utf-8', `iso-2022-7bit' and so on, which can safely encode any characters in text. This is used by the commands including: -* gnus-summary-save-article-file -* gnus-summary-save-article-body-file -* gnus-summary-write-article-file -* gnus-summary-write-article-body-file +* `gnus-summary-save-article-file' +* `gnus-summary-save-article-body-file' +* `gnus-summary-write-article-file' +* `gnus-summary-write-article-body-file' and the functions to which you may set `gnus-default-article-saver': -* gnus-summary-save-in-file -* gnus-summary-save-body-in-file -* gnus-summary-write-to-file -* gnus-summary-write-body-to-file +* `gnus-summary-save-in-file' +* `gnus-summary-save-body-in-file' +* `gnus-summary-write-to-file' +* `gnus-summary-write-body-to-file' Those commands and functions save just text displayed in the article buffer to a file if the value of this variable is non-nil. Note that @@ -8519,8 +8519,7 @@ whose names match REGEXP. For example: \((\"chinese\" . gnus-decode-encoded-word-region-by-guess) mail-decode-encoded-word-region - (\"chinese\" . rfc1843-decode-region)) -") + (\"chinese\" . rfc1843-decode-region))") (defvar gnus-decode-header-methods-cache nil) diff --git a/lisp/gnus/gnus-diary.el b/lisp/gnus/gnus-diary.el index e2cbca9007d..7ecc97262a0 100644 --- a/lisp/gnus/gnus-diary.el +++ b/lisp/gnus/gnus-diary.el @@ -21,15 +21,11 @@ ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs. If not, see . - ;;; Commentary: ;; Contents management by FCM version 0.1. -;; Description: -;; =========== - -;; gnus-diary is a utility toolkit used on top of the nndiary back end. It is +;; gnus-diary is a utility toolkit used on top of the nndiary back end. It is ;; now fully documented in the Gnus manual. ;;; Code: diff --git a/lisp/gnus/gnus-dired.el b/lisp/gnus/gnus-dired.el index af0b782202a..e9eddae942f 100644 --- a/lisp/gnus/gnus-dired.el +++ b/lisp/gnus/gnus-dired.el @@ -92,7 +92,7 @@ See `mail-user-agent' for more information." ;;;###autoload (defun turn-on-gnus-dired-mode () - "Convenience method to turn on gnus-dired-mode." + "Convenience method to turn on `gnus-dired-mode'." (interactive) (gnus-dired-mode 1)) diff --git a/lisp/gnus/gnus-icalendar.el b/lisp/gnus/gnus-icalendar.el index 5294b83d9e9..b6e5e7f786a 100644 --- a/lisp/gnus/gnus-icalendar.el +++ b/lisp/gnus/gnus-icalendar.el @@ -107,19 +107,19 @@ :accessor gnus-icalendar-event:opt-participants :initform nil :type (or null t))) - "generic iCalendar Event class") + "Generic iCalendar Event class.") (defclass gnus-icalendar-event-request (gnus-icalendar-event) nil - "iCalendar class for REQUEST events") + "iCalendar class for REQUEST events.") (defclass gnus-icalendar-event-cancel (gnus-icalendar-event) nil - "iCalendar class for CANCEL events") + "iCalendar class for CANCEL events.") (defclass gnus-icalendar-event-reply (gnus-icalendar-event) nil - "iCalendar class for REPLY events") + "iCalendar class for REPLY events.") (cl-defmethod gnus-icalendar-event:recurring-p ((event gnus-icalendar-event)) "Return t if EVENT is recurring." diff --git a/lisp/gnus/gnus-int.el b/lisp/gnus/gnus-int.el index 01053797b3a..255c11f137c 100644 --- a/lisp/gnus/gnus-int.el +++ b/lisp/gnus/gnus-int.el @@ -613,8 +613,7 @@ If BUFFER, insert the article in that group." Returns the article number of the message. If GROUP is not already selected, the message will be the only one in -the group's summary. -" +the group's summary." ;; TODO: is there a way to know at this point whether the group will ;; be newly-selected? If so we could clean up the logic at the end ;; diff --git a/lisp/gnus/gnus-ml.el b/lisp/gnus/gnus-ml.el index 3b2b5a07c1d..ee3abf2f7be 100644 --- a/lisp/gnus/gnus-ml.el +++ b/lisp/gnus/gnus-ml.el @@ -127,7 +127,7 @@ If FORCE is non-nil, replace the old ones." (t (gnus-message 1 "no list-unsubscribe in this group"))))) (defun gnus-mailing-list-post () - "Post message (really useful ?)" + "Post message (really useful ?)." (interactive) (let ((list-post (with-current-buffer gnus-original-article-buffer diff --git a/lisp/gnus/gnus-mlspl.el b/lisp/gnus/gnus-mlspl.el index 6adda2ed147..878e879cd70 100644 --- a/lisp/gnus/gnus-mlspl.el +++ b/lisp/gnus/gnus-mlspl.el @@ -75,7 +75,7 @@ match any of the group-specified splitting rules. See ;;;###autoload (defun gnus-group-split-update (&optional catch-all) - "Computes nnmail-split-fancy from group params and CATCH-ALL. + "Computes `nnmail-split-fancy' from group params and CATCH-ALL. It does this by calling (gnus-group-split-fancy nil nil CATCH-ALL). If CATCH-ALL is nil, `gnus-group-split-default-catch-all-group' is used diff --git a/lisp/gnus/gnus-msg.el b/lisp/gnus/gnus-msg.el index 863b6aa44e4..66501ef7d54 100644 --- a/lisp/gnus/gnus-msg.el +++ b/lisp/gnus/gnus-msg.el @@ -303,7 +303,7 @@ If nil, the address field will always be empty after invoking (defcustom gnus-message-highlight-citation t ;; gnus-treat-highlight-citation ;; gnus-cite dependency - "Enable highlighting of different citation levels in message-mode." + "Enable highlighting of different citation levels in `message-mode'." :version "23.1" ;; No Gnus :group 'gnus-cite :group 'gnus-message diff --git a/lisp/gnus/gnus-registry.el b/lisp/gnus/gnus-registry.el index 0468d72edd0..9b76f983227 100644 --- a/lisp/gnus/gnus-registry.el +++ b/lisp/gnus/gnus-registry.el @@ -772,7 +772,7 @@ possible. Uses `gnus-registry-split-strategy'." nil)))) (defun gnus-registry-follow-group-p (group) - "Determines if a group name should be followed. + "Determine if a group name should be followed. Consults `gnus-registry-unfollowed-groups' and `nnmail-split-fancy-with-parent-ignore-groups'." (and group @@ -789,7 +789,7 @@ Consults `gnus-registry-unfollowed-groups' and ;; we do special logic for ignoring to accept regular expressions and ;; nnmail-split-fancy-with-parent-ignore-groups as well (defun gnus-registry-ignore-group-p (group) - "Determines if a group name should be ignored. + "Determine if a group name should be ignored. Consults `gnus-registry-ignored-groups' and `nnmail-split-fancy-with-parent-ignore-groups'." (and group diff --git a/lisp/gnus/gnus-salt.el b/lisp/gnus/gnus-salt.el index 5b746a8efa9..dc81dfc5f6c 100644 --- a/lisp/gnus/gnus-salt.el +++ b/lisp/gnus/gnus-salt.el @@ -51,7 +51,7 @@ (defcustom gnus-pick-elegant-flow t "If non-nil, `gnus-pick-start-reading' runs - `gnus-summary-next-group' when no articles have been picked." +`gnus-summary-next-group' when no articles have been picked." :type 'boolean :group 'gnus-summary-pick) diff --git a/lisp/gnus/gnus-score.el b/lisp/gnus/gnus-score.el index f40da9e9c4c..0626e8bde5c 100644 --- a/lisp/gnus/gnus-score.el +++ b/lisp/gnus/gnus-score.el @@ -1093,7 +1093,7 @@ EXTRA is the possible non-standard header." (defun gnus-summary-current-score (arg) "Return the score of the current article. - With prefix ARG, return the total score of the current (sub)thread." +With prefix ARG, return the total score of the current (sub)thread." (interactive "P" gnus-article-mode gnus-summary-mode) (message "%s" (if arg (gnus-thread-total-score diff --git a/lisp/gnus/gnus-search.el b/lisp/gnus/gnus-search.el index 2a8069d400c..9c83d5fa376 100644 --- a/lisp/gnus/gnus-search.el +++ b/lisp/gnus/gnus-search.el @@ -132,7 +132,7 @@ transformed." (defcustom gnus-search-ignored-newsgroups "" "A regexp to match newsgroups in the active file that should - be skipped when searching." +be skipped when searching." :version "24.1" :type 'regexp) @@ -172,8 +172,7 @@ This variable can also be set per-server." :type 'regexp) (defcustom gnus-search-swish++-raw-queries-p nil - "If t, all Swish++ engines will only accept raw search query - strings." + "If t, all Swish++ engines will only accept raw search query strings." :type 'boolean :version "28.1") @@ -217,8 +216,7 @@ This variable can also be set per-server." :version "28.1") (defcustom gnus-search-swish-e-raw-queries-p nil - "If t, all Swish-e engines will only accept raw search query - strings." + "If t, all Swish-e engines will only accept raw search query strings." :type 'boolean :version "28.1") @@ -266,8 +264,7 @@ This variable can also be set per-server." :version "28.1") (defcustom gnus-search-namazu-raw-queries-p nil - "If t, all Namazu engines will only accept raw search query - strings." + "If t, all Namazu engines will only accept raw search query strings." :type 'boolean :version "28.1") @@ -305,14 +302,12 @@ This variable can also be set per-server." :version "28.1") (defcustom gnus-search-notmuch-raw-queries-p nil - "If t, all Notmuch engines will only accept raw search query - strings." + "If t, all Notmuch engines will only accept raw search query strings." :type 'boolean :version "28.1") (defcustom gnus-search-imap-raw-queries-p nil - "If t, all IMAP engines will only accept raw search query - strings." + "If t, all IMAP engines will only accept raw search query strings." :version "28.1" :type 'boolean) @@ -350,8 +345,7 @@ This variable can also be set per-server." :type 'regexp) (defcustom gnus-search-mairix-raw-queries-p nil - "If t, all Mairix engines will only accept raw search query - strings." + "If t, all Mairix engines will only accept raw search query strings." :version "28.1" :type 'boolean) @@ -403,7 +397,7 @@ expressions. Key is most often a mail header, but there are other keys. Value is a string, quoted if it contains spaces. Key and value are separated by a colon, no space. Expressions are implicitly ANDed; the \"or\" keyword can be used to -OR. \"not\" will negate the following expression, or keys can be +OR. \"not\" will negate the following expression, or keys can be prefixed with a \"-\". The \"near\" operator will work for engines that understand it; other engines will convert it to \"or\". Parenthetical groups work as expected. @@ -413,7 +407,7 @@ header. Search keys can be expanded with TAB during entry, or left abbreviated so long as they remain unambiguous, ie \"f\" will -search the \"from\" header. \"s\" will raise an error. +search the \"from\" header. \"s\" will raise an error. Other keys: @@ -433,7 +427,7 @@ It's also possible to use Gnus' internal marks, ie \"mark:R\" will be interpreted as mark:read. \"tag\" will search tags -- right now that's translated to -\"keyword\" in IMAP, and left as \"tag\" for notmuch. At some +\"keyword\" in IMAP, and left as \"tag\" for notmuch. At some point this should also be used to search marks in the Gnus registry. diff --git a/lisp/gnus/gnus-sieve.el b/lisp/gnus/gnus-sieve.el index eeedf7ff35c..d173decbb6a 100644 --- a/lisp/gnus/gnus-sieve.el +++ b/lisp/gnus/gnus-sieve.el @@ -61,8 +61,9 @@ For example: \"nnimap:mailbox\"" :type 'boolean) (defcustom gnus-sieve-update-shell-command "echo put %f | sieveshell %s" - "Shell command to execute after updating your Sieve script. The following -formatting characters are recognized: + "Shell command to execute after updating your Sieve script. + +The following formatting characters are recognized: %f Script's file name (gnus-sieve-file) %s Server name (from gnus-sieve-select-method)" diff --git a/lisp/gnus/gnus-srvr.el b/lisp/gnus/gnus-srvr.el index 1c75abb6f4b..115efa9805e 100644 --- a/lisp/gnus/gnus-srvr.el +++ b/lisp/gnus/gnus-srvr.el @@ -204,7 +204,7 @@ If nil, a faster, but more primitive, buffer is used instead." '((((class color) (background light)) (:foreground "ForestGreen" :inverse-video t :italic t)) (((class color) (background dark)) (:foreground "PaleGreen" :inverse-video t :italic t)) (t (:inverse-video t :italic t))) - "Face used for displaying the Cloud Host" + "Face used for displaying the Cloud Host." :group 'gnus-server-visual) (defface gnus-server-opened diff --git a/lisp/gnus/gnus-start.el b/lisp/gnus/gnus-start.el index 4bbeb24dc39..1c2e9ebd919 100644 --- a/lisp/gnus/gnus-start.el +++ b/lisp/gnus/gnus-start.el @@ -2340,9 +2340,9 @@ If FORCE is non-nil, the .newsrc file is read." (defun gnus-convert-mark-converter-prompt (converter no-prompt) "Indicate whether CONVERTER requires `gnus-convert-old-newsrc' to - display the conversion prompt. NO-PROMPT may be nil (prompt), - t (no prompt), or any form that can be called as a function. - The form should return either t or nil." +display the conversion prompt. NO-PROMPT may be nil (prompt), +t (no prompt), or any form that can be called as a function. +The form should return either t or nil." (put converter 'gnus-convert-no-prompt no-prompt)) (defun gnus-convert-converter-needs-prompt (converter) diff --git a/lisp/gnus/gnus-sum.el b/lisp/gnus/gnus-sum.el index c28e38e3156..f17bb11e6a9 100644 --- a/lisp/gnus/gnus-sum.el +++ b/lisp/gnus/gnus-sum.el @@ -1723,8 +1723,7 @@ For example: \(setq gnus-newsgroup-variables \\='(message-use-followup-to (gnus-visible-headers . - \"^From:\\\\|^Newsgroups:\\\\|^Subject:\\\\|^Date:\\\\|^To:\"))) -") + \"^From:\\\\|^Newsgroups:\\\\|^Subject:\\\\|^Date:\\\\|^To:\")))") (eval-when-compile ;; Bind features so that require will believe that gnus-sum has @@ -3146,8 +3145,9 @@ You can also post articles and send mail from this buffer. To follow up an article, type `\\[gnus-summary-followup]'. To mail a reply to the author of an article, type `\\[gnus-summary-reply]'. -There are approx. one gazillion commands you can execute in this -buffer; read the Info manual for more information (`\\[gnus-info-find-node]'). +There are approximately one gazillion commands you can execute in +this buffer; read the Info manual for more +information (`\\[gnus-info-find-node]'). The following commands are available: @@ -6843,7 +6843,7 @@ Also do horizontal recentering." (defun gnus-forward-line-ignore-invisible (n) "Move N lines forward (backward if N is negative). -Like forward-line, but skip over (and don't count) invisible lines." +Like `forward-line', but skip over (and don't count) invisible lines." (let (done) (while (and (> n 0) (not done)) ;; If the following character is currently invisible, diff --git a/lisp/gnus/gnus-util.el b/lisp/gnus/gnus-util.el index 70ae81d95ea..fb285962d6f 100644 --- a/lisp/gnus/gnus-util.el +++ b/lisp/gnus/gnus-util.el @@ -533,7 +533,7 @@ ARGS are passed to `message'." (defun gnus-extract-references (references) "Return a list of Message-IDs in REFERENCES (in In-Reply-To - format), trimmed to only contain the Message-IDs." +format), trimmed to only contain the Message-IDs." (let ((ids (gnus-split-references references)) refs) (dolist (id ids) @@ -1528,8 +1528,8 @@ sequence, this is like `mapcar'. With several, it is like the Common Lisp (t emacs-version)))) (defun gnus-rename-file (old-path new-path &optional trim) - "Rename OLD-PATH as NEW-PATH. If TRIM, recursively delete -empty directories from OLD-PATH." + "Rename OLD-PATH as NEW-PATH. +If TRIM, recursively delete empty directories from OLD-PATH." (when (file-exists-p old-path) (let* ((old-dir (file-name-directory old-path)) ;; (old-name (file-name-nondirectory old-path)) @@ -1549,7 +1549,7 @@ empty directories from OLD-PATH." (concat old-dir ".."))))))))) (defun gnus-set-file-modes (filename mode &optional flag) - "Wrapper for set-file-modes." + "Wrapper for `set-file-modes'." (ignore-errors (set-file-modes filename mode flag))) diff --git a/lisp/gnus/gnus-uu.el b/lisp/gnus/gnus-uu.el index 6c926384c97..f7b761ee339 100644 --- a/lisp/gnus/gnus-uu.el +++ b/lisp/gnus/gnus-uu.el @@ -354,12 +354,12 @@ didn't work, and overwrite existing files. Otherwise, ask each time." ;; Commands. (defun gnus-uu-decode-uu (&optional n) - "Uudecodes the current article." + "Uudecode the current article." (interactive "P" gnus-article-mode gnus-summary-mode) (gnus-uu-decode-with-method #'gnus-uu-uustrip-article n)) (defun gnus-uu-decode-uu-and-save (n dir) - "Decodes and saves the resulting file." + "Decode and save the resulting file." (interactive (list current-prefix-arg (file-name-as-directory @@ -370,12 +370,12 @@ didn't work, and overwrite existing files. Otherwise, ask each time." (gnus-uu-decode-with-method #'gnus-uu-uustrip-article n dir nil nil t)) (defun gnus-uu-decode-unshar (&optional n) - "Unshars the current article." + "Unshar the current article." (interactive "P" gnus-article-mode gnus-summary-mode) (gnus-uu-decode-with-method #'gnus-uu-unshar-article n nil nil 'scan t)) (defun gnus-uu-decode-unshar-and-save (n dir) - "Unshars and saves the current article." + "Unshar and save the current article." (interactive (list current-prefix-arg (file-name-as-directory @@ -386,7 +386,7 @@ didn't work, and overwrite existing files. Otherwise, ask each time." (gnus-uu-decode-with-method #'gnus-uu-unshar-article n dir nil 'scan t)) (defun gnus-uu-decode-save (n file) - "Saves the current article." + "Save the current article." (interactive (list current-prefix-arg (if gnus-uu-save-separate-articles @@ -399,7 +399,7 @@ didn't work, and overwrite existing files. Otherwise, ask each time." (gnus-uu-decode-with-method #'gnus-uu-save-article n nil t)) (defun gnus-uu-decode-binhex (n dir) - "Unbinhexes the current article." + "Unbinhex the current article." (interactive (list current-prefix-arg (file-name-as-directory @@ -425,13 +425,13 @@ didn't work, and overwrite existing files. Otherwise, ask each time." (gnus-uu-decode-with-method #'gnus-uu-yenc-article n dir nil t)) (defun gnus-uu-decode-uu-view (&optional n) - "Uudecodes and views the current article." + "Uudecode and view the current article." (interactive "P" gnus-article-mode gnus-summary-mode) (let ((gnus-view-pseudos (or gnus-view-pseudos 'automatic))) (gnus-uu-decode-uu n))) (defun gnus-uu-decode-uu-and-save-view (n dir) - "Decodes, views and saves the resulting file." + "Decode, view and save the resulting file." (interactive (list current-prefix-arg (read-file-name "Uudecode, view and save in dir: " @@ -442,13 +442,13 @@ didn't work, and overwrite existing files. Otherwise, ask each time." (gnus-uu-decode-uu-and-save n dir))) (defun gnus-uu-decode-unshar-view (&optional n) - "Unshars and views the current article." + "Unshar and view the current article." (interactive "P" gnus-article-mode gnus-summary-mode) (let ((gnus-view-pseudos (or gnus-view-pseudos 'automatic))) (gnus-uu-decode-unshar n))) (defun gnus-uu-decode-unshar-and-save-view (n dir) - "Unshars and saves the current article." + "Unshar and save the current article." (interactive (list current-prefix-arg (read-file-name "Unshar, view and save in dir: " @@ -459,7 +459,7 @@ didn't work, and overwrite existing files. Otherwise, ask each time." (gnus-uu-decode-unshar-and-save n dir))) (defun gnus-uu-decode-save-view (n file) - "Saves and views the current article." + "Save and view the current article." (interactive (list current-prefix-arg (if gnus-uu-save-separate-articles @@ -472,7 +472,7 @@ didn't work, and overwrite existing files. Otherwise, ask each time." (gnus-uu-decode-save n file))) (defun gnus-uu-decode-binhex-view (n file) - "Unbinhexes and views the current article." + "Unbinhex and view the current article." (interactive (list current-prefix-arg (read-file-name "Unbinhex, view and save in dir: " @@ -488,7 +488,7 @@ didn't work, and overwrite existing files. Otherwise, ask each time." ;; Digest and forward articles (defun gnus-uu-digest-mail-forward (&optional n post) - "Digests and forwards all articles in this series." + "Digest and forward all articles in this series." (interactive "P" gnus-article-mode gnus-summary-mode) (gnus-uu-initialize) (let ((gnus-uu-save-in-digest t) @@ -643,7 +643,7 @@ When called interactively, prompt for REGEXP." (gnus-uu-mark-region (point-min) (point-max) t)) (defun gnus-uu-mark-thread () - "Marks all articles downwards in this thread." + "Mark all articles downwards in this thread." (interactive nil gnus-article-mode gnus-summary-mode) (gnus-save-hidden-threads (let ((level (gnus-summary-thread-level))) @@ -654,7 +654,7 @@ When called interactively, prompt for REGEXP." (gnus-summary-position-point)) (defun gnus-uu-unmark-thread () - "Unmarks all articles downwards in this thread." + "Unmark all articles downwards in this thread." (interactive nil gnus-article-mode gnus-summary-mode) (let ((level (gnus-summary-thread-level))) (while (and (gnus-summary-remove-process-mark @@ -747,7 +747,7 @@ When called interactively, prompt for REGEXP." (gnus-uu-decode-postscript n))) (defun gnus-uu-decode-postscript-and-save (n dir) - "Extracts PostScript and saves the current article." + "Extract PostScript and save the current article." (interactive (list current-prefix-arg (file-name-as-directory (read-directory-name "Save in dir: " @@ -758,7 +758,7 @@ When called interactively, prompt for REGEXP." n dir nil nil t)) (defun gnus-uu-decode-postscript-and-save-view (n dir) - "Decodes, views and saves the resulting file." + "Decode, view and save the resulting file." (interactive (list current-prefix-arg (read-file-name "Where do you want to save the file(s)? " gnus-uu-default-dir @@ -1606,7 +1606,7 @@ Gnus might fail to display all of it.") gnus-uu-unshar-warning)) (goto-char (point-min)) (display-buffer buffer) - (yes-or-no-p "This is a shell archive, unshar it? ")) + (yes-or-no-p "This is a shell archive, unshar it?")) (kill-buffer buffer)) (setq state (list 'error)))))) (unless (memq 'error state) @@ -1925,7 +1925,7 @@ is t." (gnus-uu-post-insert-binary))))) (defun gnus-uu-post-insert-binary-in-article () - "Inserts an encoded file in the buffer. + "Insert an encoded file in the buffer. The user will be asked for a file name." (interactive) (save-excursion diff --git a/lisp/gnus/gnus.el b/lisp/gnus/gnus.el index 5009507208e..0505e33cb6e 100644 --- a/lisp/gnus/gnus.el +++ b/lisp/gnus/gnus.el @@ -2217,7 +2217,7 @@ covered by that variable." (defcustom gnus-agent t "Whether we want to use the Gnus agent or not. -You may customize gnus-agent to disable its use. However, some +You may customize `gnus-agent' to disable its use. However, some back ends have started to use the agent as a client-side cache. Disabling the agent may result in noticeable loss of performance." :version "22.1" diff --git a/lisp/help-fns.el b/lisp/help-fns.el index a7219ede944..ffbead33982 100644 --- a/lisp/help-fns.el +++ b/lisp/help-fns.el @@ -227,7 +227,7 @@ interactive command." ;;;###autoload (defun describe-function (function) "Display the full documentation of FUNCTION (a symbol). -When called from lisp, FUNCTION may also be a function object." +When called from Lisp, FUNCTION may also be a function object." (interactive (help-fns--describe-function-or-command-prompt)) ;; We save describe-function-orig-buffer on the help xref stack, so @@ -263,7 +263,7 @@ When called from lisp, FUNCTION may also be a function object." ;;;###autoload (defun describe-command (command) "Display the full documentation of COMMAND (a symbol). -When called from lisp, COMMAND may also be a function object." +When called from Lisp, COMMAND may also be a function object." (interactive (help-fns--describe-function-or-command-prompt 'is-command)) (describe-function command)) @@ -1641,7 +1641,7 @@ BUFFER defaults to the current buffer." ((char-table-p value) "deeper char-table ...") (t (condition-case nil (category-set-mnemonics value) - (error "invalid")))))) + (error "Invalid")))))) ;;;###autoload (defun describe-categories (&optional buffer) diff --git a/lisp/help-mode.el b/lisp/help-mode.el index d2066a05f7d..551cf7e1a3a 100644 --- a/lisp/help-mode.el +++ b/lisp/help-mode.el @@ -811,7 +811,7 @@ See `help-make-xrefs'." (defun help-do-xref (_pos function args) "Call the help cross-reference function FUNCTION with args ARGS. -Things are set up properly so that the resulting help-buffer has +Things are set up properly so that the resulting help buffer has a proper [back] button." ;; There is a reference at point. Follow it. (let ((help-xref-following t)) diff --git a/lisp/hexl.el b/lisp/hexl.el index 3b048ba650f..4a7bf9479aa 100644 --- a/lisp/hexl.el +++ b/lisp/hexl.el @@ -539,7 +539,7 @@ This function is intended to be used as eldoc callback." (+ N (/ N (/ hexl-bits 4))) )) ) ; char offset into hexl display line (defun hexl-goto-address (address) - "Go to hexl-mode (decimal) address ADDRESS. + "Go to `hexl-mode' (decimal) address ADDRESS. Signal error if ADDRESS is out of range." (interactive "nAddress: ") (if (or (< address 0) (> address hexl-max-address)) diff --git a/lisp/hippie-exp.el b/lisp/hippie-exp.el index 4fadbbe4180..97207090388 100644 --- a/lisp/hippie-exp.el +++ b/lisp/hippie-exp.el @@ -38,7 +38,7 @@ ;; ;; If the variable `hippie-expand-verbose' is non-nil, `hippie-expand' ;; outputs in a message which try-function in the list that is used -;; currently (ie. was used currently and will be tried first the next +;; currently (i.e. was used currently and will be tried first the next ;; time). ;; The variable `hippie-expand-max-buffers' determines in how many ;; buffers, apart from the current, to search for expansions in. It diff --git a/lisp/ibuf-ext.el b/lisp/ibuf-ext.el index 907ee8d63fc..7c95baf8cd9 100644 --- a/lisp/ibuf-ext.el +++ b/lisp/ibuf-ext.el @@ -693,7 +693,7 @@ To evaluate a form without viewing the buffer, see `ibuffer-do-eval'." (defun ibuffer-included-in-filters-p (buf filters) "Return non-nil if BUF passes all FILTERS. -BUF is a lisp buffer object, and FILTERS is a list of filter +BUF is a Lisp buffer object, and FILTERS is a list of filter specifications with the same structure as `ibuffer-filtering-qualifiers'." (not @@ -714,7 +714,7 @@ where operand d is itself a cons cell, or nil. Returns d." (defun ibuffer-included-in-filter-p (buf filter) "Return non-nil if BUF pass FILTER. -BUF is a lisp buffer object, and FILTER is a filter +BUF is a Lisp buffer object, and FILTER is a filter specification, with the same structure as an element of the list `ibuffer-filtering-qualifiers'." (if (eq (car filter) 'not) diff --git a/lisp/icomplete.el b/lisp/icomplete.el index 0fa5f367349..01033474d38 100644 --- a/lisp/icomplete.el +++ b/lisp/icomplete.el @@ -165,7 +165,7 @@ icompletion is occurring." "Overlay used to display the list of completions.") (defvar icomplete--initial-input nil - "Initial input in the minibuffer when icomplete-mode was activated. + "Initial input in the minibuffer when `icomplete-mode' was activated. Used to implement the option `icomplete-show-matches-on-no-input'.") (defun icomplete-post-command-hook () diff --git a/lisp/ido.el b/lisp/ido.el index b81a9db5eb9..7c2d2eb0d75 100644 --- a/lisp/ido.el +++ b/lisp/ido.el @@ -834,7 +834,7 @@ Each function on the list may modify the dynamically bound variable :type 'hook) (defcustom ido-rewrite-file-prompt-functions nil - "List of functions to run when the find-file prompt is created. + "List of functions to run when the `find-file' prompt is created. Each function on the list may modify the following dynamically bound variables: dirname - the (abbreviated) directory name @@ -3620,7 +3620,7 @@ Uses and updates `ido-dir-file-cache'." (defun ido-make-file-list-1 (dir &optional merged) - "Return list of non-ignored files in DIR + "Return list of non-ignored files in DIR. If MERGED is non-nil, each file is cons'ed with DIR." (and (or (ido-is-tramp-root dir) (ido-is-unc-root dir) (file-directory-p dir)) @@ -4397,7 +4397,7 @@ For details of keybindings, see `ido-find-file'." ;;;###autoload (defun ido-dired-other-window () - "\"Edit\" a directory. Like `ido-dired' but selects in another window. + "\"Edit\" a directory. Like `ido-dired' but select in another window. The directory is selected interactively by typing a substring. For details of keybindings, see `ido-find-file'." (interactive) @@ -4408,7 +4408,7 @@ For details of keybindings, see `ido-find-file'." ;;;###autoload (defun ido-dired-other-frame () - "\"Edit\" a directory. Like `ido-dired' but makes a new frame. + "\"Edit\" a directory. Like `ido-dired' but make a new frame. The directory is selected interactively by typing a substring. For details of keybindings, see `ido-find-file'." (interactive) diff --git a/lisp/iimage.el b/lisp/iimage.el index 192530a8e6a..b18dd841fcb 100644 --- a/lisp/iimage.el +++ b/lisp/iimage.el @@ -50,7 +50,7 @@ :group 'image) (defcustom iimage-mode-image-search-path nil - "List of directories to search for image files for iimage-mode." + "List of directories to search for image files for `iimage-mode'." :type '(choice (const nil) (repeat directory))) (defvar iimage-mode-image-filename-regex diff --git a/lisp/image-mode.el b/lisp/image-mode.el index 69ef7015cce..4a326cdc693 100644 --- a/lisp/image-mode.el +++ b/lisp/image-mode.el @@ -1241,7 +1241,7 @@ will have the line where the image appears (if any) marked. If no such buffer exists, it will be opened." (interactive) (unless buffer-file-name - (error "The current buffer doesn't visit a file.")) + (error "Current buffer is not visiting a file")) (image-mode--mark-file buffer-file-name #'dired-mark "marked")) (defun image-mode-unmark-file () @@ -1253,7 +1253,7 @@ any). If no such buffer exists, it will be opened." (interactive) (unless buffer-file-name - (error "The current buffer doesn't visit a file.")) + (error "Current buffer is not visiting a file")) (image-mode--mark-file buffer-file-name #'dired-unmark "unmarked")) (declare-function dired-mark "dired" (arg &optional interactive)) diff --git a/lisp/image.el b/lisp/image.el index 494c26a8a33..6e1dbbdf5cd 100644 --- a/lisp/image.el +++ b/lisp/image.el @@ -817,7 +817,7 @@ in which case you might want to use `image-default-frame-delay'." (cons images delay))))) (defun image-animated-p (image) - "Like `image-multi-frame-p', but returns nil if no delay is specified." + "Like `image-multi-frame-p', but return nil if no delay is specified." (let ((multi (image-multi-frame-p image))) (and (cdr multi) multi))) diff --git a/lisp/informat.el b/lisp/informat.el index bac09752b70..b552e8532aa 100644 --- a/lisp/informat.el +++ b/lisp/informat.el @@ -446,7 +446,7 @@ Check that every node pointer points to an existing node." ;;;###autoload (defun batch-info-validate () - "Runs `Info-validate' on the files remaining on the command line. + "Run `Info-validate' on the files remaining on the command line. Must be used only with -batch, and kills Emacs on completion. Each file will be processed even if an error occurred previously. For example, invoke \"emacs -batch -f batch-info-validate $info/ ~/*.info\"" diff --git a/lisp/international/characters.el b/lisp/international/characters.el index 54dca609518..a877722f4e9 100644 --- a/lisp/international/characters.el +++ b/lisp/international/characters.el @@ -1416,7 +1416,7 @@ with L, LRE, or LRO Unicode bidi character type.") (defun use-default-char-width-table () "Internal use only. -Setup char-width-table appropriate for non-CJK language environment." +Setup `char-width-table' appropriate for non-CJK language environment." (while (char-table-parent char-width-table) (setq char-width-table (char-table-parent char-width-table)))) diff --git a/lisp/international/iso-cvt.el b/lisp/international/iso-cvt.el index ead7c8aa619..f0bfe9f6825 100644 --- a/lisp/international/iso-cvt.el +++ b/lisp/international/iso-cvt.el @@ -22,7 +22,7 @@ ;; along with GNU Emacs. If not, see . ;;; Commentary: -;; This lisp code is a general framework for translating various +;; This Lisp code is a general framework for translating various ;; representations of the same data. ;; among other things it can be used to translate TeX, HTML, and compressed ;; files to ISO 8859-1. It can also be used to translate different charsets @@ -37,7 +37,7 @@ ;; SEE ALSO: ; If you are interested in questions related to using the ISO 8859-1 -; characters set (configuring emacs, Unix, etc. to use ISO), then you +; characters set (configuring Emacs, Unix, etc. to use ISO), then you ; can get the ISO 8859-1 FAQ via anonymous ftp from ; ftp.vlsivie.tuwien.ac.at in /pub/8bit/FAQ-ISO-8859-1 diff --git a/lisp/international/latexenc.el b/lisp/international/latexenc.el index ff7cddcb26e..9449b3bb851 100644 --- a/lisp/international/latexenc.el +++ b/lisp/international/latexenc.el @@ -31,13 +31,13 @@ ;; If this fails it will search for AUCTeX's TeX-master or tex-mode's ;; tex-main-file variable in the local variables section and visit -;; that file to get the coding system from the master file. This check +;; that file to get the coding system from the master file. This check ;; can be disabled by setting `latexenc-dont-use-TeX-master-flag' to ;; t. ;; If we have still not found a coding system we will try to use the ;; standard tex-mode's `tex-guess-main-file' and get the coding system -;; from the main file. This check can be disabled by setting +;; from the main file. This check can be disabled by setting ;; `latexenc-dont-use-tex-guess-main-file-flag' to t. ;; The functionality is enabled by adding the function diff --git a/lisp/international/mule.el b/lisp/international/mule.el index 1a53237f14a..ee116976eaa 100644 --- a/lisp/international/mule.el +++ b/lisp/international/mule.el @@ -1148,7 +1148,7 @@ Value is a list of transformed arguments." (,(plist-get props 'decode) . ,(plist-get props 'encode)) ,properties ,eol-type)) (t - (error "unsupported XEmacs style make-coding-style arguments: %S" + (error "Unsupported XEmacs style make-coding-style arguments: %S" `(,name ,type ,doc-string ,props)))))) (defun merge-coding-systems (first second) diff --git a/lisp/international/quail.el b/lisp/international/quail.el index 5d1311530a5..c0e53d26fba 100644 --- a/lisp/international/quail.el +++ b/lisp/international/quail.el @@ -2020,7 +2020,7 @@ minibuffer and the selected frame has no other windows)." (bury-buffer quail-completion-buf) ;; Then, show the guidance. - (when (and + (when (and ;; Don't try to display guidance on an expired minibuffer. This ;; would go into an infinite wait rather than executing the user's ;; command. Bug #45792. diff --git a/lisp/jsonrpc.el b/lisp/jsonrpc.el index f1fb6c1ddaf..6b5abcbd7c8 100644 --- a/lisp/jsonrpc.el +++ b/lisp/jsonrpc.el @@ -239,7 +239,7 @@ The caller can expect SUCCESS-FN or ERROR-FN to be called with a JSONRPC `:result' or `:error' object, respectively. If this doesn't happen after TIMEOUT seconds (defaults to `jrpc-default-request-timeout'), the caller can expect TIMEOUT-FN -to be called with no arguments. The default values of SUCCESS-FN, +to be called with no arguments. The default values of SUCCESS-FN, ERROR-FN and TIMEOUT-FN simply log the events into `jsonrpc-events-buffer'. @@ -363,7 +363,7 @@ expected to understand JSONRPC messages with basic HTTP-style enveloping headers such as \"Content-Length:\". :ON-SHUTDOWN (optional), a function of one argument, the -connection object, called when the process dies .") +connection object, called when the process dies.") (cl-defmethod initialize-instance ((conn jsonrpc-process-connection) slots) (cl-call-next-method) diff --git a/lisp/kermit.el b/lisp/kermit.el index fdab7e5a505..25f1f300f35 100644 --- a/lisp/kermit.el +++ b/lisp/kermit.el @@ -29,7 +29,7 @@ ;; is that I can log onto machines with primitive operating systems (VMS and ;; ATT system V :-), and still have the features of shell-mode available for ;; command history, etc. It's also handy to be able to run a file transfer in -;; an emacs window. The transfer is in the "background", but you can also +;; an Emacs window. The transfer is in the "background", but you can also ;; monitor or stop it easily. ;; The ^\ key is bound to a function for sending escape sequences to kermit, diff --git a/lisp/kmacro.el b/lisp/kmacro.el index 8821e35c2d1..a39f433cdc3 100644 --- a/lisp/kmacro.el +++ b/lisp/kmacro.el @@ -22,7 +22,7 @@ ;;; Commentary: -;; The kmacro package provides the user interface to emacs' basic +;; The kmacro package provides the user interface to Emacs' basic ;; keyboard macro functionality. With kmacro, two function keys are ;; dedicated to keyboard macros, by default F3 and F4. @@ -144,7 +144,7 @@ macro to be executed before appending to it." (defcustom kmacro-repeat-no-prefix t - "Allow repeating certain macro commands without entering the C-x C-k prefix." + "Allow repeating certain macro commands without entering the \\[kmacro-keymap] prefix." :type 'boolean) (defcustom kmacro-call-repeat-key t @@ -728,7 +728,7 @@ With \\[universal-argument], call second macro in macro ring." (defun kmacro-end-or-call-macro-repeat (arg) - "As `kmacro-end-or-call-macro' but allows repeat without repeating prefix." + "As `kmacro-end-or-call-macro' but allow repeat without repeating prefix." (interactive "P") (let ((keys (kmacro-get-repeat-prefix))) (kmacro-end-or-call-macro arg t) diff --git a/lisp/language/ind-util.el b/lisp/language/ind-util.el index 8d4b2a826e6..6f579f23833 100644 --- a/lisp/language/ind-util.el +++ b/lisp/language/ind-util.el @@ -487,7 +487,7 @@ c trans-c)) (defun indian-make-hash (table trans-table) - "Indian Transliteration Hash for decode/encode" + "Indian Transliteration Hash for decode/encode." (let* ((encode-hash (make-hash-table :test 'equal)) (decode-hash (make-hash-table :test 'equal)) (hashtbls (cons encode-hash decode-hash)) @@ -809,11 +809,11 @@ ;; only Devanagari is supported now. (concat "[" (char-to-string #x0900) "-" (char-to-string #x097f) "]") - "Regexp that matches to conversion") + "Regexp that matches to conversion.") (defun indian-ucs-to-iscii-region (from to) - "Converts the indian UCS characters in the region to ISCII. -Returns new end position." + "Convert the indian UCS characters in the region to ISCII. +Return new end position." (interactive "r") ;; only Devanagari is supported now. (save-excursion @@ -828,8 +828,8 @@ Returns new end position." (point-max)))) (defun indian-iscii-to-ucs-region (from to) - "Converts the ISCII characters in the region to UCS. -Returns new end position." + "Convert the ISCII characters in the region to UCS. +Return new end position." (interactive "r") ;; only Devanagari is supported now. (save-excursion diff --git a/lisp/language/thai-word.el b/lisp/language/thai-word.el index 5d0389c28df..d12064958e1 100644 --- a/lisp/language/thai-word.el +++ b/lisp/language/thai-word.el @@ -64,7 +64,6 @@ ;; the sale, use or other dealings in this Software without prior ;; written authorization of the copyright holder. - ;;; Commentary: ;; This file implements an algorithm to find Thai word breaks using a @@ -76,6 +75,8 @@ ;; which means that you can easily index the list character by ;; character. +;;; Code: + (defvar thai-word-table (let ((table (list 'thai-words))) (dolist (elt @@ -10740,8 +10741,8 @@ (defun thai-update-word-table (file &optional append) - "Update Thai word table by replacing the current word list with -FILE. If called with a prefix argument, FILE is appended instead to + "Update Thai word table by replacing the current word list with FILE. +If called with a prefix argument, FILE is appended instead to the current word list." (interactive "FThai word table file: \nP") (let ((buf (generate-new-buffer "*thai-work*")) @@ -11041,20 +11042,20 @@ If COUNT is negative, move point forward (- COUNT) words." (defun thai-kill-word (arg) - "Like kill-word but pay attention to Thai word boundaries. + "Like `kill-word' but pay attention to Thai word boundaries. With argument, do this that many times." (interactive "p") (kill-region (point) (progn (thai-forward-word arg) (point)))) (defun thai-backward-kill-word (arg) - "Like backward-kill-word but pay attention to Thai word boundaries." + "Like `backward-kill-word' but pay attention to Thai word boundaries." (interactive "p") (thai-kill-word (- arg))) (defun thai-transpose-words (arg) - "Like transpose-words but pay attention to Thai word boundaries." + "Like `transpose-words' but pay attention to Thai word boundaries." (interactive "*p") (transpose-subr 'thai-forward-word arg)) diff --git a/lisp/language/tibet-util.el b/lisp/language/tibet-util.el index ddf4a0c0fb1..1f7a1edcad3 100644 --- a/lisp/language/tibet-util.el +++ b/lisp/language/tibet-util.el @@ -281,8 +281,9 @@ The returned string has no composition information." ;;;###autoload (defun tibetan-decompose-region (from to) "Decompose Tibetan text in the region FROM and TO. -This is different from decompose-region because precomposed Tibetan characters -are decomposed into normal Tibetan character sequences." +This is different from `decompose-region' because precomposed +Tibetan characters are decomposed into normal Tibetan character +sequences." (interactive "r") (save-restriction (narrow-to-region from to) @@ -301,8 +302,9 @@ are decomposed into normal Tibetan character sequences." ;;;###autoload (defun tibetan-decompose-string (str) "Decompose Tibetan string STR. -This is different from decompose-string because precomposed Tibetan characters -are decomposed into normal Tibetan character sequences." +This is different from `decompose-string' because precomposed +Tibetan characters are decomposed into normal Tibetan character +sequences." (let ((new "") (len (length str)) (idx 0) @@ -332,7 +334,7 @@ See also the documentation of the function `tibetan-decompose-region'." ;;;###autoload (defun tibetan-compose-buffer () "Composes Tibetan character components in the buffer. -See also docstring of the function tibetan-compose-region." +See also docstring of the function `tibetan-compose-region'." (interactive) (make-local-variable 'tibetan-decomposed) (tibetan-compose-region (point-min) (point-max)) diff --git a/lisp/language/tv-util.el b/lisp/language/tv-util.el index 207d76f47c1..d380630c0a6 100644 --- a/lisp/language/tv-util.el +++ b/lisp/language/tv-util.el @@ -21,12 +21,11 @@ ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs. If not, see . -;;; Code +;;; Code: -;; Regexp matching with a sequence of Tai Viet characters. -(defconst tai-viet-re "[\xaa80-\xaac2\xaadb-\xaadf]+") +(defconst tai-viet-re "[\xaa80-\xaac2\xaadb-\xaadf]+" + "Regexp matching with a sequence of Tai Viet characters.") -;; Char-table of information about glyph type of Tai Viet characters. (defconst tai-viet-glyph-info (let ((table (make-char-table nil)) (specials '((right-overhang . "ꪊꪋꪌꪍꪏꪓꪖꪜꪞꪡꪤꪨ") @@ -43,7 +42,8 @@ (chars (cdr elt))) (dotimes (i (length chars)) (aset table (aref chars i) category)))) - table)) + table) + "Char-table of information about glyph type of Tai Viet characters.") (defun tai-viet-compose-string (from to string) "Compose Tai Viet characters in STRING between indices FROM and TO." diff --git a/lisp/leim/quail/sami.el b/lisp/leim/quail/sami.el index 6c9b2d99cc0..0f0bae9eca8 100644 --- a/lisp/leim/quail/sami.el +++ b/lisp/leim/quail/sami.el @@ -33,7 +33,7 @@ ;; - skolt-sami-prefix ;; - kildin-sami-prefix -;;; Code +;;; Code: (require 'quail) diff --git a/lisp/leim/quail/vnvni.el b/lisp/leim/quail/vnvni.el index faccc0afc53..57e0dfd8205 100644 --- a/lisp/leim/quail/vnvni.el +++ b/lisp/leim/quail/vnvni.el @@ -303,3 +303,5 @@ and postfix: E66 -> E6, a55 -> a5, etc. ;; Local Variables: ;; coding: utf-8 ;; End: + +;;; vnvni.el ends here diff --git a/lisp/loadup.el b/lisp/loadup.el index 158c02eceaa..0ea441de012 100644 --- a/lisp/loadup.el +++ b/lisp/loadup.el @@ -520,7 +520,7 @@ lost after dumping"))) ((equal dump-mode "dump") "emacs") ((equal dump-mode "bootstrap") "emacs") ((equal dump-mode "pbootstrap") "bootstrap-emacs.pdmp") - (t (error "unrecognized dump mode %s" dump-mode))))) + (t (error "Unrecognized dump mode %s" dump-mode))))) (when (and (featurep 'native-compile) (equal dump-mode "pdump")) ;; Don't enable this before bootstrap is completed, as the diff --git a/lisp/locate.el b/lisp/locate.el index c4dbe2af02b..008d65e055f 100644 --- a/lisp/locate.el +++ b/lisp/locate.el @@ -25,7 +25,7 @@ ;; Search a database of files and use dired commands on the result. ;; ;; Locate.el provides an interface to a program which searches a -;; database of file names. By default, this program is the GNU locate +;; database of file names. By default, this program is the GNU locate ;; command, but it could also be the BSD-style find command, or even a ;; user specified command. ;; @@ -39,7 +39,7 @@ ;; To use a more complicated expression, create a function which ;; takes a string (the name to find) as input and returns a list. ;; The first element should be the command to be executed, the remaining -;; elements should be the arguments (including the name to find). Then put +;; elements should be the arguments (including the name to find). Then put ;; ;; (setq locate-make-command-line 'my-locate-command-line) ;; @@ -47,25 +47,25 @@ ;; my-locate-command-line. ;; ;; You should make sure that whichever command you use works correctly -;; from a shell prompt. GNU locate and BSD find expect the file databases +;; from a shell prompt. GNU locate and BSD find expect the file databases ;; to either be in standard places or located via environment variables. ;; If the latter, make sure these environment variables are set in ;; your emacs process. ;; ;; Locate-mode assumes that each line output from the locate-command ;; consists exactly of a file name, possibly preceded or trailed by -;; whitespace. If your file database has other information on the line (for +;; whitespace. If your file database has other information on the line (for ;; example, the file size), you will need to redefine the function ;; `locate-get-file-positions' to return a list consisting of the first ;; character in the file name and the last character in the file name. ;; ;; To use locate-mode, simply type M-x locate and then the string -;; you wish to find. You can use almost all of the dired commands in +;; you wish to find. You can use almost all of the dired commands in ;; the resulting *Locate* buffer. It is worth noting that your commands -;; do not, of course, affect the file database. For example, if you +;; do not, of course, affect the file database. For example, if you ;; compress a file in the locate buffer, the actual file will be ;; compressed, but the entry in the file database will not be -;; affected. Consequently, the database and the filesystem will be out +;; affected. Consequently, the database and the filesystem will be out ;; of sync until the next time the database is updated. ;; ;; The command `locate-with-filter' keeps only lines matching a diff --git a/lisp/ls-lisp.el b/lisp/ls-lisp.el index 9041b9ac0f9..8e81f79e429 100644 --- a/lisp/ls-lisp.el +++ b/lisp/ls-lisp.el @@ -599,7 +599,7 @@ to a non-nil value." "Return t if versioned string S1 should sort before versioned string S2. Case is significant if `ls-lisp-ignore-case' is nil. -This is the same as string-lessp (with the exception of case +This is the same as `string-lessp' (with the exception of case insensitivity), but sequences of digits are compared numerically, as a whole, in the same manner as the `strverscmp' function available in some standard C libraries does." diff --git a/lisp/macros.el b/lisp/macros.el index faa1f0bd35d..689c4210cd7 100644 --- a/lisp/macros.el +++ b/lisp/macros.el @@ -26,7 +26,7 @@ ;; Extension commands for keyboard macros. These permit you to assign ;; a name to the last-defined keyboard macro, expand and insert the -;; lisp corresponding to a macro, query the user from within a macro, +;; Lisp corresponding to a macro, query the user from within a macro, ;; or apply a macro to each line in the reason. ;;; Code: diff --git a/lisp/mail/blessmail.el b/lisp/mail/blessmail.el index f380f0df290..23fddfd1679 100644 --- a/lisp/mail/blessmail.el +++ b/lisp/mail/blessmail.el @@ -27,7 +27,7 @@ ;; which (on systems that need it) is used during installation ;; to give appropriate permissions to movemail. ;; -;; It has to be done from lisp in order to be sure of getting the +;; It has to be done from Lisp in order to be sure of getting the ;; correct value of rmail-spool-directory. ;;; Code: diff --git a/lisp/mail/feedmail.el b/lisp/mail/feedmail.el index 083d8feae4e..608062fba4e 100644 --- a/lisp/mail/feedmail.el +++ b/lisp/mail/feedmail.el @@ -47,7 +47,7 @@ ;; A NOTE TO THOSE WHO WOULD CHANGE THIS CODE... Since it is PD, ;; you're within your rights to do whatever you want. If you do ;; publish a new version with your changes in it, please (1) insert -;; lisp comments describing the changes, (2) insert lisp comments +;; Lisp comments describing the changes, (2) insert Lisp comments ;; that clearly delimit where your changes are, (3) email me a copy ;; (I can't always consistently follow the relevant usenet groups), ;; and (4) use a version number that is based on the version you're @@ -128,7 +128,7 @@ ;; --- you can generate/modify an X-Mailer: message header ;; ;; After a long list of options below, you will find the function -;; feedmail-send-it. Hers's the best way to use the stuff in this +;; feedmail-send-it. Hers's the best way to use the stuff in this ;; file: ;; ;; Save this file as feedmail.el somewhere on your elisp loadpath; @@ -157,7 +157,7 @@ ;; If you are wondering how to send your messages to some SMTP server ;; (which is not really a feedmail-specific issue), you are probably ;; looking for smtpmail.el, and it is probably already present in your -;; emacs installation. Look at smtpmail.el for how to set that up, and +;; Emacs installation. Look at smtpmail.el for how to set that up, and ;; then do this to hook it into feedmail: ;; ;; (autoload 'feedmail-buffer-to-smtpmail "feedmail" nil t) @@ -939,7 +939,7 @@ a message you see a bit later. There is a separate queue for draft messages, intended to prevent you from accidentally sending incomplete messages. The queues are disk-based and intended for later transmission. The messages are -queued in their raw state as they appear in the mail-mode buffer and +queued in their raw state as they appear in the `mail-mode' buffer and can be arbitrarily edited later, before sending, by visiting the appropriate file in the queue directory (and setting the buffer to mail-mode or whatever). If you visit a file in the queue directory @@ -1286,7 +1286,7 @@ of casual real use only to the feedmail developer." "Duration of pause after feedmail-debug messages. After some messages are divulged, it may be helpful to pause before something else obliterates them. This value controls the duration of -the pause. If the value is nil or 0, the sit-for is not done, which +the pause. If the value is nil or 0, the `sit-for' is not done, which has the effect of not pausing at all. Debug messages can be seen after the fact in the messages buffer." :version "24.1" @@ -3149,7 +3149,7 @@ been weeded out." (sit-for feedmail-queue-chatty-sit-for)))) (defun feedmail-find-eoh (&optional noerror) - "Internal; finds the end of message header fields, returns mark just before it." + "Internal; find the end of message header fields, return mark just before it." ;; all this funny business with line endings is to account for CRLF ;; weirdness that I don't think I'll ever figure out (feedmail-say-debug ">in-> feedmail-find-eoh %s" noerror) diff --git a/lisp/mail/footnote.el b/lisp/mail/footnote.el index b7656022814..716348a9c19 100644 --- a/lisp/mail/footnote.el +++ b/lisp/mail/footnote.el @@ -39,15 +39,15 @@ ;; commands. ;; + more language styles. ;; + The key sequence 'C-c ! a C-y C-c ! b' should auto-fill the -;; footnote in adaptive fill mode. This does not seem to be a bug in +;; footnote in adaptive fill mode. This does not seem to be a bug in ;; `adaptive-fill' because it behaves that way on all point movements ;; + Handle footmode mode elegantly in all modes, even if that means refuses to -;; accept the burden. For example, in a programming language mode, footnotes +;; accept the burden. For example, in a programming language mode, footnotes ;; should be commented. ;; + Manually autofilling the a first footnote should not cause it to ;; wrap into the footnote section tag ;; + Current solution adds a second newline after the section tag, so it is -;; clearly a separate paragraph. There may be stylistic objections to this. +;; clearly a separate paragraph. There may be stylistic objections to this. ;; + Footnotes with multiple paragraphs should not have their first ;; line out-dented. ;; + Upon leaving footnote area, perform an auto-fill on an entire @@ -55,7 +55,7 @@ ;; + fill-paragraph takes arg REGION, but seemingly only when called ;; interactively. ;; + At some point, it became necessary to change `footnote-section-tag-regexp' -;; to remove its trailing space. (Adaptive fill side-effect?) +;; to remove its trailing space. (Adaptive fill side-effect?) ;; + useful for lazy testing ;; (setq footnote-narrow-to-footnotes-when-editing t) ;; (setq footnote-section-tag "Footnotes: ") @@ -151,7 +151,7 @@ has no effect on buffers already displaying footnotes." (defcustom footnote-align-to-fn-text t "How to left-align footnote text. If nil, footnote text is to be aligned flush left with left side -of the footnote number. If non-nil, footnote text is to be aligned +of the footnote number. If non-nil, footnote text is to be aligned left with the first character of footnote text." :type 'boolean) @@ -243,7 +243,7 @@ Wrapping around the alphabet implies successive repetitions of letters." "List of roman numerals with their values.") (defconst footnote-roman-upper-regexp (upcase footnote-roman-lower-regexp) - "Regexp of roman numerals. Not complete") + "Regexp of roman numerals. Not complete.") (defun footnote--roman-upper (n) "Generic Roman number footnoting." @@ -380,8 +380,8 @@ Use Unicode characters for footnoting." (concat "[" (apply #'concat footnote-hebrew-symbolic) "]")) (defun footnote--hebrew-symbolic (n) - "Only 22 elements, per the style of eg. 'פירוש שפתי חכמים על רש״י'. -Proceeds from `י' to `כ', from `צ' to `ק'. After `ת', rolls over to `א'." + "Only 22 elements, per the style of e.g. 'פירוש שפתי חכמים על רש״י'. +Proceeds from `י' to `כ', from `צ' to `ק'. After `ת', rolls over to `א'." (nth (mod (1- n) 22) footnote-hebrew-symbolic)) ;;; list of all footnote styles @@ -679,7 +679,7 @@ instead, if applicable." (defun footnote--get-area-point-max () "Return the end of footnote area. This is either `point-max' or the start of a `.signature' string, as -defined by variable `footnote-signature-separator'. If there is no +defined by variable `footnote-signature-separator'. If there is no footnote area, returns `point-max'." (save-excursion (footnote--goto-char-point-max))) diff --git a/lisp/mail/mailabbrev.el b/lisp/mail/mailabbrev.el index 5cb4a7469a9..62d9b12bb26 100644 --- a/lisp/mail/mailabbrev.el +++ b/lisp/mail/mailabbrev.el @@ -76,10 +76,10 @@ ;; should make sure your version does before including verbose addresses like ;; this. One solution to this, if you are on a system whose /bin/mail doesn't ;; work that way, (and you still want to be able to /bin/mail to send mail in -;; addition to emacs) is to define minimal aliases (without full names) in +;; addition to Emacs) is to define minimal aliases (without full names) in ;; your .mailrc file, and use define-mail-abbrev to redefine them when sending -;; mail from emacs; this way, mail sent from /bin/mail will work, and mail -;; sent from emacs will be pretty. +;; mail from Emacs; this way, mail sent from /bin/mail will work, and mail +;; sent from Emacs will be pretty. ;; ;; Aliases in the mailrc file may be nested. If you define aliases like ;; alias group1 fred ethel @@ -98,7 +98,7 @@ ;; normally cannot contain hyphens, but this code works around that for the ;; specific case of mail-alias word-abbrevs. ;; -;; To read in the contents of another .mailrc-type file from emacs, use the +;; To read in the contents of another .mailrc-type file from Emacs, use the ;; command Meta-X merge-mail-abbrevs. The rebuild-mail-abbrevs command is ;; similar, but will delete existing aliases first. ;; @@ -363,7 +363,7 @@ double-quotes." (defun mail-resolve-all-aliases-1 (sym &optional so-far) (if (memq sym so-far) - (error "mail alias loop detected: %s" + (error "Mail alias loop detected: %s" (mapconcat #'symbol-name (cons sym so-far) " <- "))) (let ((definition (and (boundp sym) (symbol-value sym)))) (if definition @@ -388,7 +388,7 @@ double-quotes." (defun mail-abbrev-expand-hook () "For use as the fourth arg to `define-abbrev'. After expanding a mail-abbrev, if Auto Fill mode is on and we're past the -fill-column, break the line at the previous comma, and indent the next line +`fill-column', break the line at the previous comma, and indent the next line with a space." (when auto-fill-function (let (p) diff --git a/lisp/mail/mailclient.el b/lisp/mail/mailclient.el index 5c153ce1c1f..e6833806d92 100644 --- a/lisp/mail/mailclient.el +++ b/lisp/mail/mailclient.el @@ -198,7 +198,7 @@ The mail client is taken to be the handler of mailto URLs." ((string= character-coding "quoted-printable") (mail-unquote-printable-region (point-min) (point-max) nil nil t)) - (t (error "unsupported Content-Transfer-Encoding: %s" + (t (error "Unsupported Content-Transfer-Encoding: %s" character-coding))) (decode-coding-region (point-min) (point-max) coding-system)) (mailclient-encode-string-as-url diff --git a/lisp/mail/mspools.el b/lisp/mail/mspools.el index 6d834140582..a36ccd98dcb 100644 --- a/lisp/mail/mspools.el +++ b/lisp/mail/mspools.el @@ -29,7 +29,7 @@ ;; to be read in them. It assumes that new mail for the file `folder' ;; is written by the filter to a file called `folder.spool'. (If the ;; file writes directly to `folder' you may lose mail if new mail -;; arrives whilst you are reading the folder in emacs, hence the use +;; arrives whilst you are reading the folder in Emacs, hence the use ;; of a spool file.) For example, the following procmail recipe puts ;; any mail with `emacs' in the subject line into the spool file ;; `emacs.spool', ready to go into the folder `emacs'. @@ -342,7 +342,7 @@ This is useful if `mspools-update' is nil." (kill-buffer mspools-buffer)) (define-derived-mode mspools-mode special-mode "MSpools" - "Major mode for output from mspools-show. + "Major mode for output from `mspools-show'. \\Move point to one of the items in this buffer, then use \\[mspools-visit-spool] to go to the spool that the current line refers to. \\[revert-buffer] to regenerate the list of spools. diff --git a/lisp/mail/reporter.el b/lisp/mail/reporter.el index 4b70582a261..2983a11d749 100644 --- a/lisp/mail/reporter.el +++ b/lisp/mail/reporter.el @@ -36,7 +36,7 @@ ;; reporter.el was written primarily for Emacs Lisp package authors so ;; that their users can more easily report bugs. When invoked, ;; `reporter-submit-bug-report' will set up an outgoing mail buffer -;; with the appropriate bug report address, including a lisp +;; with the appropriate bug report address, including a Lisp ;; expression the maintainer of the package can evaluate to completely ;; reproduce the environment in which the bug was observed (e.g. by ;; using `eval-last-sexp'). This package proved especially useful @@ -158,7 +158,7 @@ composed.") (error indent-enclosing-p)))) (defun reporter-lisp-indent (_indent-point state) - "A better lisp indentation style for bug reporting." + "A better Lisp indentation style for bug reporting." (save-excursion (goto-char (1+ (nth 1 state))) (current-column))) diff --git a/lisp/mail/rmail-spam-filter.el b/lisp/mail/rmail-spam-filter.el index fbac9e0cc0c..75a6c723695 100644 --- a/lisp/mail/rmail-spam-filter.el +++ b/lisp/mail/rmail-spam-filter.el @@ -72,6 +72,8 @@ ;;; rmail-spam-filter such that the spam is rejected by ;;; rmail-spam-filter itself. +;;; Code: + (require 'rmail) (require 'rmailsum) diff --git a/lisp/mail/rmail.el b/lisp/mail/rmail.el index 8a38337773e..9fbc9ba180f 100644 --- a/lisp/mail/rmail.el +++ b/lisp/mail/rmail.el @@ -207,8 +207,7 @@ or `-k' to enable Kerberos authentication." (defvar rmail-remote-password-error "invalid usercode or password\\| unknown user name or bad password\\|Authentication failed\\|MU_ERR_AUTH_FAILURE" - "Regular expression matching incorrect-password POP or IMAP server error -messages. + "Regexp matching incorrect-password POP or IMAP server error messages. If you get an incorrect-password error that this expression does not match, please report it with \\[report-emacs-bug].") @@ -4483,7 +4482,7 @@ TEXT and INDENT are not used." (defun rmail-get-remote-password (imap user host) "Get the password for retrieving mail from a POP or IMAP server. -If none has been set, the password is found via auth-source. If +If none has been set, the password is found via auth-source. If you use ~/.authinfo as your auth-source backend, then put something like the following in that file: diff --git a/lisp/mail/rmailout.el b/lisp/mail/rmailout.el index 4c23686909c..91f86a234d4 100644 --- a/lisp/mail/rmailout.el +++ b/lisp/mail/rmailout.el @@ -434,7 +434,7 @@ AS-SEEN is non-nil if we are copying the message \"as seen\"." (defun rmail-output-to-rmail-buffer (tembuf msg) "Copy message in TEMBUF into the current Rmail buffer. -Do what is necessary to make Rmail know about the new message. then +Do what is necessary to make Rmail know about the new message, then display message number MSG." (save-excursion (rmail-swap-buffers-maybe) diff --git a/lisp/mail/supercite.el b/lisp/mail/supercite.el index d545b0c3f15..f393ac773f5 100644 --- a/lisp/mail/supercite.el +++ b/lisp/mail/supercite.el @@ -1299,7 +1299,7 @@ use it instead of `sc-citation-root-regexp'." (defvar sc-fill-begin 1 "Buffer position to begin filling.") (defvar sc-fill-line-prefix "" - "Fill prefix of previous line") + "Fill prefix of previous line.") ;; filling (defun sc-fill-if-different (&optional prefix) diff --git a/lisp/menu-bar.el b/lisp/menu-bar.el index 8def1575b24..d863f34df1c 100644 --- a/lisp/menu-bar.el +++ b/lisp/menu-bar.el @@ -2772,7 +2772,7 @@ This is the keyboard interface to \\[mouse-buffer-menu]." km)) (defun menu-bar-define-mouse-key (map key def) - "Like `define-key', but adds all possible prefixes for the mouse." + "Like `define-key', but add all possible prefixes for the mouse." (define-key map (vector key) def) (mapc (lambda (prefix) (define-key map (vector prefix key) def)) ;; This list only needs to contain special window areas that diff --git a/lisp/midnight.el b/lisp/midnight.el index 8b798926c1c..b3adbf00172 100644 --- a/lisp/midnight.el +++ b/lisp/midnight.el @@ -26,7 +26,7 @@ ;; To use the file, put (require 'midnight) into your .emacs. Then, at ;; midnight, Emacs will run the normal hook `midnight-hook'. You can ;; put whatever you like there, say, `calendar'; by default there is -;; only one function there - `clean-buffer-list'. It will kill the +;; only one function there - `clean-buffer-list'. It will kill the ;; buffers matching `clean-buffer-list-kill-buffer-names' and ;; `clean-buffer-list-kill-regexps' and the buffers which where last ;; displayed more than `clean-buffer-list-delay-general' days ago, diff --git a/lisp/minibuf-eldef.el b/lisp/minibuf-eldef.el index 30273fab1b8..f67ec353c88 100644 --- a/lisp/minibuf-eldef.el +++ b/lisp/minibuf-eldef.el @@ -160,7 +160,7 @@ The prompt and initial input should already have been inserted." ;; post-command-hook to swap prompts when necessary (defun minibuf-eldef-update-minibuffer () "Update a minibuffer's prompt to include a default only when applicable. -This is intended to be used as a minibuffer post-command-hook for +This is intended to be used as a minibuffer `post-command-hook' for `minibuffer-electric-default-mode'; the minibuffer should have already been set up by `minibuf-eldef-setup-minibuffer'." (unless (eq minibuf-eldef-showing-default-in-prompt diff --git a/lisp/mouse-copy.el b/lisp/mouse-copy.el index 14fbb51b27e..38c85064f3b 100644 --- a/lisp/mouse-copy.el +++ b/lisp/mouse-copy.el @@ -75,7 +75,7 @@ ;; . I'd like ;; to incorporate some of these ideas into mouse-copy. The only ;; lose is that this is not the current Emacs Way Of Doing Things, so -;; there would be a learning curve for existing emacs users. +;; there would be a learning curve for existing Emacs users. ;; ;; ;; Thanks: @@ -110,7 +110,7 @@ The problem occurs under XFree86-3.1.1 (X11R6pl11) but not under X11R5, and under post-19.29 but not early versions of Emacs. 19.29 and 19.30 seems to drop mouse drag events -sometimes. (Reproducible under XFree86-3.1.1 (X11R6pl11) and +sometimes. (Reproducible under XFree86-3.1.1 (X11R6pl11) and XFree86-3.1.2 under Linux 1.2.x. Doesn't occur under X11R5 and SunOS 4.1.1.) diff --git a/lisp/mpc.el b/lisp/mpc.el index 029f0ca8f42..1f4cb4fe9cd 100644 --- a/lisp/mpc.el +++ b/lisp/mpc.el @@ -197,10 +197,10 @@ numerically rather than lexicographically." (defcustom mpc-host (concat (or (getenv "MPD_HOST") "localhost") (if (getenv "MPD_PORT") (concat ":" (getenv "MPD_PORT")))) - "Host (and port) where the Music Player Daemon is running. The -format is \"HOST\", \"HOST:PORT\", \"PASSWORD@HOST\" or -\"PASSWORD@HOST:PORT\" where PASSWORD defaults to no password, PORT -defaults to 6600 and HOST defaults to localhost." + "Host (and port) where the Music Player Daemon is running. +The format is \"HOST\", \"HOST:PORT\", \"PASSWORD@HOST\" or +\"PASSWORD@HOST:PORT\" where PASSWORD defaults to no password, +PORT defaults to 6600 and HOST defaults to localhost." :type 'string) (defvar mpc-proc nil) diff --git a/lisp/net/ange-ftp.el b/lisp/net/ange-ftp.el index c51766d168a..25ae20702a3 100644 --- a/lisp/net/ange-ftp.el +++ b/lisp/net/ange-ftp.el @@ -230,7 +230,7 @@ ;; ;; 1. For dired to work on a host which marks symlinks with a trailing @ in ;; an ls -alF listing, you need to (setq dired-ls-F-marks-symlinks t). -;; Most UNIX systems do not do this, but ULTRIX does. If you think that +;; Most UNIX systems do not do this, but ULTRIX does. If you think that ;; there is a chance you might connect to an ULTRIX machine (such as ;; prep.ai.mit.edu), then set this variable accordingly. This will have ;; the side effect that dired will have problems with symlinks whose names @@ -241,34 +241,34 @@ ;; frequently, and ange-ftp seems to be unable to guess its host-type, ;; then setting the appropriate host-type regexp ;; (ange-ftp-vms-host-regexp, ange-ftp-mts-host-regexp, or -;; ange-ftp-cms-host-regexp) accordingly should help. Also, please report +;; ange-ftp-cms-host-regexp) accordingly should help. Also, please report ;; ange-ftp's inability to recognize the host-type as a bug. ;; ;; 3. For slow connections, you might get "listing unreadable" error ;; messages, or get an empty buffer for a file that you know has something -;; in it. The solution is to increase the value of ange-ftp-retry-time. +;; in it. The solution is to increase the value of ange-ftp-retry-time. ;; Its default value is 5 which is plenty for reasonable connections. ;; However, for some transatlantic connections I set this to 20. ;; -;; 4. Beware of compressing files on non-UNIX hosts. Ange-ftp will do it by +;; 4. Beware of compressing files on non-UNIX hosts. Ange-ftp will do it by ;; copying the file to the local machine, compressing it there, and then -;; sending it back. Binary file transfers between machines of different -;; architectures can be a risky business. Test things out first on some -;; test files. See "Bugs" below. Also, note that ange-ftp copies files by -;; moving them through the local machine. Again, be careful when doing +;; sending it back. Binary file transfers between machines of different +;; architectures can be a risky business. Test things out first on some +;; test files. See "Bugs" below. Also, note that ange-ftp copies files by +;; moving them through the local machine. Again, be careful when doing ;; this with binary files on non-Unix machines. ;; ;; 5. Beware that dired over ftp will use your setting of dired-no-confirm ;; (list of dired commands for which confirmation is not asked). You ;; might want to reconsider your setting of this variable, because you ;; might want confirmation for more commands on remote direds than on -;; local direds. For example, I strongly recommend that you not include -;; compress and uncompress in this list. If there is enough demand it +;; local direds. For example, I strongly recommend that you not include +;; compress and uncompress in this list. If there is enough demand it ;; might be a good idea to have an alist ange-ftp-dired-no-confirm of ;; pairs ( TYPE . LIST ), where TYPE is an operating system type and LIST ;; is a list of commands for which confirmation would be suppressed. Then ;; remote dired listings would take their (buffer-local) value of -;; dired-no-confirm from this alist. Who votes for this? +;; dired-no-confirm from this alist. Who votes for this? ;; --------------------------------------------------------------------- ;; Non-UNIX support: @@ -277,7 +277,7 @@ ;; VMS support: ;; ;; Ange-ftp has full support for VMS hosts. It should be able to -;; automatically recognize any VMS machine. However, if it fails to do +;; automatically recognize any VMS machine. However, if it fails to do ;; this, you can use the command ange-ftp-add-vms-host. Also, you can ;; set the variable ange-ftp-vms-host-regexp in your init file. We ;; would be grateful if you would report any failures to automatically @@ -308,46 +308,46 @@ ;; Therefore, to access a VMS file, you must enter the filename with upper ;; case letters. ;; 2. To access the latest version of file under VMS, you use the filename -;; without the ";" and version number. You should always edit the latest -;; version of a file. If you want to edit an earlier version, copy it to a -;; new file first. This has nothing to do with ange-ftp, but is simply -;; good VMS operating practice. Therefore, to edit FILE.TXT;3 (say 3 is -;; latest version), do C-x C-f /ymir.claremont.edu:FILE.TXT. If you +;; without the ";" and version number. You should always edit the latest +;; version of a file. If you want to edit an earlier version, copy it to a +;; new file first. This has nothing to do with ange-ftp, but is simply +;; good VMS operating practice. Therefore, to edit FILE.TXT;3 (say 3 is +;; latest version), do C-x C-f /ymir.claremont.edu:FILE.TXT. If you ;; inadvertently do C-x C-f /ymir.claremont.edu:FILE.TXT;3, you will find ;; that VMS will not allow you to save the file because it will refuse to ;; overwrite FILE.TXT;3, but instead will want to create FILE.TXT;4, and -;; attach the buffer to this file. To get out of this situation, M-x +;; attach the buffer to this file. To get out of this situation, M-x ;; write-file /ymir.claremont.edu:FILE.TXT will attach the buffer to -;; latest version of the file. For this reason, in dired "f" +;; latest version of the file. For this reason, in dired "f" ;; (dired-find-file), always loads the file sans version, whereas "v", -;; (dired-view-file), always loads the explicit version number. The +;; (dired-view-file), always loads the explicit version number. The ;; reasoning being that it reasonable to view old versions of a file, but ;; not to edit them. ;; 3. EMACS has a feature in which it does environment variable substitution -;; in filenames. Therefore, to enter a $ in a filename, you must quote it +;; in filenames. Therefore, to enter a $ in a filename, you must quote it ;; by typing $$. ;; MTS support: ;; ;; Ange-ftp has full support for hosts running ;; the Michigan terminal system. It should be able to automatically -;; recognize any MTS machine. However, if it fails to do this, you can use +;; recognize any MTS machine. However, if it fails to do this, you can use ;; the command ange-ftp-add-mts-host. As well, you can set the variable -;; ange-ftp-mts-host-regexp in your init file. We would be grateful if you +;; ange-ftp-mts-host-regexp in your init file. We would be grateful if you ;; would report any failures to automatically recognize a MTS host as a bug. ;; ;; Filename syntax: ;; -;; MTS filenames are entered in a UNIX-y way. For example, if your account +;; MTS filenames are entered in a UNIX-y way. For example, if your account ;; was YYYY, the file FILE in the account XXXX: on mtsg.ubc.ca would be ;; entered as ;; /YYYY@mtsg.ubc.ca:/XXXX:/FILE -;; In other words, MTS accounts are treated as UNIX directories. Of course, +;; In other words, MTS accounts are treated as UNIX directories. Of course, ;; to access a file in another account, you must have access permission for ;; it. If FILE were in your own account, then you could enter it in a ;; relative name fashion as ;; /YYYY@mtsg.ubc.ca:FILE -;; MTS filenames can be up to 12 characters. Like UNIX, the structure of the +;; MTS filenames can be up to 12 characters. Like UNIX, the structure of the ;; filename does not contain a TYPE (i.e. it can have as many "."'s as you ;; like.) MTS filenames are always in upper case, and hence be sure to enter ;; them as such! MTS is not case sensitive, but an EMACS running under UNIX @@ -359,37 +359,37 @@ ;; CMS. It should be able to automatically recognize any CMS machine. ;; However, if it fails to do this, you can use the command ;; ange-ftp-add-cms-host. As well, you can set the variable -;; ange-ftp-cms-host-regexp in your init file. We would be grateful if you +;; ange-ftp-cms-host-regexp in your init file. We would be grateful if you ;; would report any failures to automatically recognize a CMS host as a bug. ;; ;; Filename syntax: ;; -;; CMS filenames are entered in a UNIX-y way. In other words, minidisks are -;; treated as UNIX directories. For example to access the file READ.ME in +;; CMS filenames are entered in a UNIX-y way. In other words, minidisks are +;; treated as UNIX directories. For example to access the file READ.ME in ;; minidisk *.311 on cuvmb.cc.columbia.edu, you would enter ;; /anonymous@cuvmb.cc.columbia.edu:/*.311/READ.ME ;; If *.301 is the default minidisk for this account, you could access ;; FOO.BAR on this minidisk as ;; /anonymous@cuvmb.cc.columbia.edu:FOO.BAR ;; CMS filenames are of the form FILE.TYPE, where both FILE and TYPE can be -;; up to 8 characters. Again, beware that CMS filenames are always upper +;; up to 8 characters. Again, beware that CMS filenames are always upper ;; case, and hence must be entered as such. ;; ;; Tips: ;; 1. CMS machines, with the exception of anonymous accounts, nearly always -;; need an account password. To have ange-ftp send an account password, +;; need an account password. To have ange-ftp send an account password, ;; you can either include it in your .netrc file, or use ;; ange-ftp-set-account. -;; 2. Ange-ftp cannot send "write passwords" for a minidisk. Hopefully, we +;; 2. Ange-ftp cannot send "write passwords" for a minidisk. Hopefully, we ;; can fix this. ;; ;; BS2000 support: ;; ;; Ange-ftp has full support for BS2000 hosts. It should be able to -;; automatically recognize any BS2000 machine. However, if it fails to +;; automatically recognize any BS2000 machine. However, if it fails to ;; do this, you can use the command ange-ftp-add-bs2000-host. As well, ;; you can set the variable ange-ftp-bs2000-host-regexp in your .emacs -;; file. We would be grateful if you would report any failures to auto- +;; file. We would be grateful if you would report any failures to auto- ;; matically recognize a BS2000 host as a bug. ;; ;; If you want to access the POSIX subsystem on BS2000 you MUST use @@ -436,10 +436,10 @@ ;; Therefore, to access a BS2000 file, you must enter the filename with ;; upper case letters. ;; 2. EMACS has a feature in which it does environment variable substitution -;; in filenames. Therefore, to enter a $ in a filename, you must quote it +;; in filenames. Therefore, to enter a $ in a filename, you must quote it ;; by typing $$. ;; 3. BS2000 machines, with the exception of anonymous accounts, nearly -;; always need an account password. To have ange-ftp send an account +;; always need an account password. To have ange-ftp send an account ;; password, you can either include it in your .netrc file, or use ;; ange-ftp-set-account. ;; @@ -457,15 +457,15 @@ ;; ;; 2. Some combinations of FTP clients and servers break and get out of sync ;; when asked to list a non-existent directory. Some of the ai.mit.edu -;; machines cause this problem for some FTP clients. Using +;; machines cause this problem for some FTP clients. Using ;; ange-ftp-kill-ftp-process can restart the ftp process, which ;; should get things back in sync. ;; ;; 3. Ange-ftp does not check to make sure that when creating a new file, ;; you provide a valid filename for the remote operating system. ;; If you do not, then the remote FTP server will most likely -;; translate your filename in some way. This may cause ange-ftp to -;; get confused about what exactly is the name of the file. The +;; translate your filename in some way. This may cause ange-ftp to +;; get confused about what exactly is the name of the file. The ;; most common causes of this are using lower case filenames on systems ;; which support only upper case, and using filenames which are too ;; long. @@ -479,39 +479,39 @@ ;; disgusting way around this problem is to talk to the FTP process via ;; rlogin which does the 'right' things with pty's. ;; -;; 6. For CMS support, we send too many cd's. Since cd's are cheap, I haven't -;; worried about this too much. Eventually, we should have some caching +;; 6. For CMS support, we send too many cd's. Since cd's are cheap, I haven't +;; worried about this too much. Eventually, we should have some caching ;; of the current minidisk. ;; ;; 7. Some CMS machines do not assign a default minidisk when you ftp them as -;; anonymous. It is then necessary to guess a valid minidisk name, and cd -;; to it. This is (understandably) beyond ange-ftp. +;; anonymous. It is then necessary to guess a valid minidisk name, and cd +;; to it. This is (understandably) beyond ange-ftp. ;; ;; 8. Remote to remote copying of files on non-Unix machines can be risky. ;; Depending on the variable ange-ftp-binary-file-name-regexp, ange-ftp -;; will use binary mode for the copy. Between systems of different +;; will use binary mode for the copy. Between systems of different ;; architecture, this still may not be enough to guarantee the integrity -;; of binary files. Binary file transfers from VMS machines are -;; particularly problematical. Should ange-ftp-binary-file-name-regexp be +;; of binary files. Binary file transfers from VMS machines are +;; particularly problematical. Should ange-ftp-binary-file-name-regexp be ;; an alist of OS type, regexp pairs? ;; ;; 9. The code to do compression of files over ftp is not as careful as it -;; should be. It deletes the old remote version of the file, before +;; should be. It deletes the old remote version of the file, before ;; actually checking if the local to remote transfer of the compressed -;; file succeeds. Of course to delete the original version of the file +;; file succeeds. Of course to delete the original version of the file ;; after transferring the compressed version back is also dangerous, ;; because some OS's have severe restrictions on the length of filenames, ;; and when the compressed version is copied back the "-Z" or ".Z" may be -;; truncated. Then, ange-ftp would delete the only remaining version of +;; truncated. Then, ange-ftp would delete the only remaining version of ;; the file. Maybe ange-ftp should make backups when it compresses files ;; (of course, the backup "~" could also be truncated off, sigh...). ;; Suggestions? ;; ;; 10. If a dir listing is attempted for an empty directory on (at least -;; some) VMS hosts, an ftp error is given. This is really an ftp bug, and +;; some) VMS hosts, an ftp error is given. This is really an ftp bug, and ;; I don't know how to get ange-ftp work to around it. ;; -;; 11. Bombs on filenames that start with a space. Deals well with filenames +;; 11. Bombs on filenames that start with a space. Deals well with filenames ;; containing spaces, but beware that the remote ftpd may not like them ;; much. ;; @@ -519,13 +519,13 @@ ;; It needs to be reimplemented by modifying the parse-...-listing ;; functions to convert the directory listing to ls -l format. ;; -;; 13. The famous @ bug. As mentioned above in TIPS, ULTRIX marks symlinks -;; with a trailing @ in a ls -alF listing. In order to account for this +;; 13. The famous @ bug. As mentioned above in TIPS, ULTRIX marks symlinks +;; with a trailing @ in a ls -alF listing. In order to account for this ;; ange-ftp looks to chop trailing @'s off of symlink names when it is -;; parsing a listing with the F switch. This will cause ange-ftp to +;; parsing a listing with the F switch. This will cause ange-ftp to ;; incorrectly get the name of a symlink on a non-ULTRIX host if its name -;; ends in an @. ange-ftp will correct itself if you take F out of the -;; dired ls switches (C-u s will allow you to edit the switches). The +;; ends in an @. ange-ftp will correct itself if you take F out of the +;; dired ls switches (C-u s will allow you to edit the switches). The ;; dired buffer will be automatically reverted, which will allow ange-ftp ;; to fix its files hashtable. A cookie to anyone who can think of a ;; fast, sure-fire way to recognize ULTRIX over ftp. @@ -576,26 +576,26 @@ ;; and the current code should eventually be made compliant. ;; ;; nil = local host type, whatever that is (probably unix). -;; Think nil as in "not a remote host". This value is used by +;; Think nil as in "not a remote host". This value is used by ;; ange-ftp-dired-host-type for local buffers. ;; -;; t = a remote host of unknown type. Think t as in true, it's remote. +;; t = a remote host of unknown type. Think t as in true, it's remote. ;; Currently, `unix' is used as the default remote host type. ;; Maybe we should use t. ;; ;; TYPE = a remote host of TYPE type. ;; ;; TYPE:LIST = a remote host of TYPE type, using a specialized ftp listing -;; program called list. This is currently only used for Unix +;; program called list. This is currently only used for Unix ;; dl (descriptive listings), when ange-ftp-dired-host-type ;; is set to `unix:dl'. ;; Bug report codes: ;; ;; Because of their naive faith in this code, there are certain situations -;; which the writers of this program believe could never happen. However, +;; which the writers of this program believe could never happen. However, ;; being realists they have put calls to `error' in the program at these -;; points. These errors provide a code, which is an integer, greater than 1. +;; points. These errors provide a code, which is an integer, greater than 1. ;; To aid debugging. the error codes, and the functions in which they reside ;; are listed below. ;; @@ -1025,7 +1025,7 @@ or nil meaning don't change it." "Buffer name to hold directory listing data received from FTP process.") (defvar ange-ftp-netrc-modtime nil - "Last modified time of the netrc file from file-attributes.") + "Last modified time of the netrc file from `file-attributes'.") (defvar ange-ftp-user-hashtable (make-hash-table :test 'equal) "Hash table holding associations between HOST, USER pairs.") @@ -2641,7 +2641,7 @@ away in the internal cache." (ange-ftp-error host user (concat "DIR failed: " (cdr result))))) (ange-ftp-del-tmp-name temp)))) - (error "Should never happen. Please report. Bug ref. no.: 1")))) + (error "This should never happen; please report this as a bug")))) ;;;; ------------------------------------------------------------ ;;;; Directory information caching support. @@ -5134,7 +5134,7 @@ NEWNAME should be the name to give the new compressed or uncompressed file.") (concat "/" drive "/")) dir (and dir "/") file)) - (error "name %s didn't match" name)) + (error "Name %s didn't match" name)) (let (drive dir file tmp quote) (if (string-match "\\`\".+\"\\'" name) (setq name (substring name 1 -1) @@ -5662,7 +5662,7 @@ Other orders of $ and _ seem to all work just fine.") (setq file (match-string 2 name)) (concat (and acct (concat "/" acct "/")) file)) - (error "name %s didn't match" name)) + (error "Name %s didn't match" name)) (if (string-match "\\`/\\([^:]+:\\)/\\(.*\\)\\'" name) (concat (match-string 1 name) (match-string 2 name)) ;; Let's hope that mts will recognize it anyway. @@ -6096,7 +6096,7 @@ Other orders of $ and _ seem to all work just fine.") (and pubset (concat "_/" pubset "/")) (and userid (concat userid "/")) filename)) - (error "name %s didn't match" name)) + (error "Name %s didn't match" name)) ;; and here we (maybe) have to remove the inserted "_/" 'cause ;; of our prevention of the special escape prefix above: (if (string-match (concat "^/_/") name) diff --git a/lisp/net/browse-url.el b/lisp/net/browse-url.el index bf77ecc7af7..b21c66ef14b 100644 --- a/lisp/net/browse-url.el +++ b/lisp/net/browse-url.el @@ -1754,11 +1754,11 @@ from `browse-url-elinks-wrapper'." (define-key map [mouse-2] #'browse-url-button-open) (define-key map "w" #'browse-url-button-copy) map) - "The keymap used for browse-url buttons.") + "The keymap used for `browse-url' buttons.") (defface browse-url-button '((t :inherit link)) - "Face for browse-url buttons (i.e., links)." + "Face for `browse-url' buttons (i.e., links)." :version "27.1") (defun browse-url-add-buttons () diff --git a/lisp/net/dictionary.el b/lisp/net/dictionary.el index 4947caba699..85467cd7828 100644 --- a/lisp/net/dictionary.el +++ b/lisp/net/dictionary.el @@ -1312,9 +1312,9 @@ allows editing it." "Turn off or on support for the dictionary tooltip mode. It is normally internally called with 1 to enable support for the -tooltip mode. The hook function will check the value of the -variable dictionary-tooltip-mode to decide if some action must be -taken. When disabling the tooltip mode the value of this variable +tooltip mode. The hook function will check the value of the +variable `dictionary-tooltip-mode' to decide if some action must be +taken. When disabling the tooltip mode the value of this variable will be set to nil." (interactive) (tooltip-mode on) @@ -1345,10 +1345,10 @@ active it will overwrite that mode for the current buffer." ;;;###autoload (defun global-dictionary-tooltip-mode (&optional arg) - "Enable/disable dictionary-tooltip-mode for all buffers. + "Enable/disable `dictionary-tooltip-mode' for all buffers. -Internally it provides a default for the dictionary-tooltip-mode. -It can be overwritten for each buffer using dictionary-tooltip-mode. +Internally it provides a default for the `dictionary-tooltip-mode'. +It can be overwritten for each buffer using `dictionary-tooltip-mode'. Note: (global-dictionary-tooltip-mode 0) will not disable the mode any buffer where (dictionary-tooltip-mode 1) has been called." diff --git a/lisp/net/eudc.el b/lisp/net/eudc.el index 517913ff016..5c451c6556d 100644 --- a/lisp/net/eudc.el +++ b/lisp/net/eudc.el @@ -25,7 +25,7 @@ ;;; Commentary: ;; This package provides a common interface to query directory servers using ;; different protocols such as LDAP, CCSO PH/QI or BBDB. Queries can be -;; made through an interactive form or inline. Inline query strings in +;; made through an interactive form or inline. Inline query strings in ;; buffers are expanded with appropriately formatted query results ;; (especially used to expand email addresses in message buffers). EUDC ;; also interfaces with the BBDB package to let you register query results diff --git a/lisp/net/eww.el b/lisp/net/eww.el index 28569eeeb10..c1202974f45 100644 --- a/lisp/net/eww.el +++ b/lisp/net/eww.el @@ -36,7 +36,7 @@ (eval-when-compile (require 'subr-x)) (defgroup eww nil - "Emacs Web Wowser" + "Emacs Web Wowser." :version "25.1" :link '(custom-manual "(eww) Top") :group 'web diff --git a/lisp/net/gnutls.el b/lisp/net/gnutls.el index 43dd9dc15cd..7b1ea2e765e 100644 --- a/lisp/net/gnutls.el +++ b/lisp/net/gnutls.el @@ -226,7 +226,7 @@ trust and key files, and priority string." trustfiles crlfiles keylist min-prime-bits verify-flags verify-error verify-hostname-error &allow-other-keys) - "Negotiate a SSL/TLS connection. Returns proc. Signals gnutls-error. + "Negotiate a SSL/TLS connection. Return proc. Signal gnutls-error. Note that arguments are passed CL style, :type TYPE instead of just TYPE. diff --git a/lisp/net/goto-addr.el b/lisp/net/goto-addr.el index 78f6f3d915b..848bad3b0d6 100644 --- a/lisp/net/goto-addr.el +++ b/lisp/net/goto-addr.el @@ -125,7 +125,7 @@ will have no effect.") "Keymap to hold goto-addr's mouse key defs under highlighted URLs.") (defun goto-address-context-menu (menu click) - "Populate MENU with goto-address commands at CLICK." + "Populate MENU with `goto-address' commands at CLICK." (when (mouse-posn-property (event-start click) 'goto-address) (define-key menu [goto-address-separator] menu-bar-separator) (define-key menu [goto-address-at-mouse] diff --git a/lisp/net/ldap.el b/lisp/net/ldap.el index 7997bf3c90b..8b63dce2113 100644 --- a/lisp/net/ldap.el +++ b/lisp/net/ldap.el @@ -51,7 +51,8 @@ a separator." (defcustom ldap-default-port nil "Default TCP port for LDAP connections. -Initialized from the LDAP library at build time. Default value is 389." +Initialized from the LDAP library at build time. +Default value is 389." :type '(choice (const :tag "Use library default" nil) (integer :tag "Port number"))) diff --git a/lisp/net/mailcap.el b/lisp/net/mailcap.el index 5473ba7e697..83d0eeef9f1 100644 --- a/lisp/net/mailcap.el +++ b/lisp/net/mailcap.el @@ -93,7 +93,7 @@ The elements of the list are alists of the following structure (type . MIME-TYPE) (test . TEST)) -where VIEWER is either a lisp command, e.g., a major-mode, or a +where VIEWER is either a Lisp command, e.g., a major mode, or a string containing a shell command for viewing files of the defined MIME-TYPE. In case of a shell command, %s will be replaced with the file. @@ -101,7 +101,7 @@ replaced with the file. MIME-TYPE is a regular expression being matched against the actual MIME type. It is implicitly surrounded with ^ and $. -TEST is a lisp form which is evaluated in order to test if the +TEST is a Lisp form which is evaluated in order to test if the entry should be chosen. The `test' entry is optional. When selecting a viewer for a given MIME type, the first viewer diff --git a/lisp/net/nsm.el b/lisp/net/nsm.el index 1d9ee6db86c..2ac1df1d58a 100644 --- a/lisp/net/nsm.el +++ b/lisp/net/nsm.el @@ -34,7 +34,7 @@ (defvar nsm-temporary-host-settings nil) (defgroup nsm nil - "Network Security Manager" + "Network Security Manager." :version "25.1" :group 'comm) @@ -446,8 +446,8 @@ this check has no effect on GnuTLS >= 3.2.0. Reference: -[1]: Schneier, Bruce (1996). Applied Cryptography (Second ed.). John -Wiley & Sons. ISBN 0-471-11709-9. +[1]: Schneier, Bruce (1996). Applied Cryptography (Second ed.). +John Wiley & Sons. ISBN 0-471-11709-9. [2]: N. Mavrogiannopoulos, FSF (Apr 2015). \"GnuTLS NEWS -- History of user-visible changes.\" Version 3.4.0, `https://gitlab.com/gnutls/gnutls/blob/master/NEWS'" @@ -466,7 +466,7 @@ man-in-the-middle attacks. Reference: -GnuTLS authors (2018). \"GnuTLS Manual 4.3.3 Anonymous +GnuTLS authors (2018). \"GnuTLS Manual 4.3.3 Anonymous authentication\", `https://www.gnutls.org/manual/gnutls.html#Anonymous-authentication'" (let ((kx (plist-get status :key-exchange))) diff --git a/lisp/net/quickurl.el b/lisp/net/quickurl.el index 2574c8cb63e..046953faf6e 100644 --- a/lisp/net/quickurl.el +++ b/lisp/net/quickurl.el @@ -24,19 +24,19 @@ ;;; Commentary: ;; ;; This package provides a simple method of inserting a URL based on the -;; text at point in the current buffer. This is part of an on-going effort +;; text at point in the current buffer. This is part of an on-going effort ;; to increase the information I provide people while reducing the amount -;; of typing I need to do. No-doubt there are undiscovered Emacs packages +;; of typing I need to do. No-doubt there are undiscovered Emacs packages ;; out there that do all of this and do it better, feel free to point me to ;; them, in the mean time I'm having fun playing with Emacs Lisp. ;; ;; The URLs are stored in an external file as a list of either cons cells, -;; or lists. A cons cell entry looks like this: +;; or lists. A cons cell entry looks like this: ;; ;; ( . ) ;; ;; where is a string that acts as the keyword lookup and is -;; the URL associated with it. An example might be: +;; the URL associated with it. An example might be: ;; ;; ("GNU" . "https://www.gnu.org/") ;; @@ -45,8 +45,8 @@ ;; ( ) ;; ;; where and are the same as with the cons cell and -;; is any text you like that describes the URL. This description will be -;; used when presenting a list of URLS using `quickurl-list'. An example +;; is any text you like that describes the URL. This description will be +;; used when presenting a list of URLS using `quickurl-list'. An example ;; might be: ;; ;; ("FSF" "https://www.fsf.org/" "The Free Software Foundation") @@ -215,8 +215,8 @@ Note that this function is a setfable place." (defun quickurl-url-comment (url) "Get the comment from a URL. -If the URL has no comment an empty string is returned. Also note that this -function is a setfable place." +If the URL has no comment an empty string is returned. Also note +that this function is a setfable place." (declare (gv-setter (lambda (store) `(if (quickurl-url-commented-p ,url) diff --git a/lisp/net/sasl-cram.el b/lisp/net/sasl-cram.el index 4022a35b391..2427f4976e3 100644 --- a/lisp/net/sasl-cram.el +++ b/lisp/net/sasl-cram.el @@ -24,6 +24,8 @@ ;;; Commentary: +;;; Code: + (require 'sasl) (require 'hmac-md5) diff --git a/lisp/net/sasl-digest.el b/lisp/net/sasl-digest.el index 5afc195d4b4..3696f526b5d 100644 --- a/lisp/net/sasl-digest.el +++ b/lisp/net/sasl-digest.el @@ -29,9 +29,9 @@ ;; It is caller's responsibility to base64-decode challenges and ;; base64-encode responses in IMAP4 AUTHENTICATE command. ;; -;; Passphrase should be longer than 16 bytes. (See RFC 2195) +;; Passphrase should be longer than 16 bytes. (See RFC 2195) -;;; Commentary: +;;; Code: (require 'sasl) (require 'hmac-md5) diff --git a/lisp/net/secrets.el b/lisp/net/secrets.el index 4102b9d322a..4217c219ad9 100644 --- a/lisp/net/secrets.el +++ b/lisp/net/secrets.el @@ -159,7 +159,7 @@ "Whether there is a daemon offering the Secret Service API.") (defvar secrets-debug nil - "Write debug messages") + "Write debug messages.") (defconst secrets-service "org.freedesktop.secrets" "The D-Bus name used to talk to Secret Service.") diff --git a/lisp/net/shr-color.el b/lisp/net/shr-color.el index eb78a259a8c..aa92c365f87 100644 --- a/lisp/net/shr-color.el +++ b/lisp/net/shr-color.el @@ -30,7 +30,7 @@ (eval-when-compile (require 'cl-lib)) (defgroup shr-color nil - "Simple HTML Renderer colors" + "Simple HTML Renderer colors." :group 'shr) (defcustom shr-color-visible-luminance-min 40 diff --git a/lisp/net/shr.el b/lisp/net/shr.el index 85d81b6bbcc..a8e15c1e0ae 100644 --- a/lisp/net/shr.el +++ b/lisp/net/shr.el @@ -43,7 +43,7 @@ (require 'text-property-search) (defgroup shr nil - "Simple HTML Renderer" + "Simple HTML Renderer." :version "25.1" :group 'web) diff --git a/lisp/net/sieve-manage.el b/lisp/net/sieve-manage.el index 1f08a15e570..64544bcf154 100644 --- a/lisp/net/sieve-manage.el +++ b/lisp/net/sieve-manage.el @@ -410,7 +410,7 @@ If BUFFER is nil, the current buffer is used." (defun sieve-manage-capability (&optional name value buffer) "Check if capability NAME of server BUFFER match VALUE. -If it does, return the server value of NAME. If not returns nil. +If it does, return the server value of NAME. If not return nil. If VALUE is nil, do not check VALUE and return server value. If NAME is nil, return the full server list of capabilities." (with-current-buffer (or buffer (current-buffer)) diff --git a/lisp/net/sieve-mode.el b/lisp/net/sieve-mode.el index 0e8fdc0a905..70cebd30396 100644 --- a/lisp/net/sieve-mode.el +++ b/lisp/net/sieve-mode.el @@ -132,7 +132,7 @@ (modify-syntax-entry ?\} "){" st) (modify-syntax-entry ?\" "\"" st) st) - "Syntax table in use in sieve-mode buffers.") + "Syntax table in use in `sieve-mode' buffers.") ;; Key map definition diff --git a/lisp/net/sieve.el b/lisp/net/sieve.el index 6d571a0a30f..99bc0a7acd2 100644 --- a/lisp/net/sieve.el +++ b/lisp/net/sieve.el @@ -224,7 +224,7 @@ require \"fileinto\"; (substitute-command-keys "\\[sieve-upload]")))) (defmacro sieve-change-region (&rest body) - "Turns off sieve-region before executing BODY, then re-enables it after. + "Turn off sieve-region before executing BODY, then re-enables it after. Used to bracket operations which move point in the sieve-buffer." (declare (indent 0) (debug t)) `(progn diff --git a/lisp/net/snmp-mode.el b/lisp/net/snmp-mode.el index ae878ef3a51..10892ebf611 100644 --- a/lisp/net/snmp-mode.el +++ b/lisp/net/snmp-mode.el @@ -328,7 +328,7 @@ Tab indents for C code. Comments start with -- and end with newline or another --. Delete converts tabs to spaces as it moves back. \\{snmp-mode-map} -Turning on snmp-mode runs the hooks in `snmp-common-mode-hook', then +Turning on `snmp-mode' runs the hooks in `snmp-common-mode-hook', then `snmp-mode-hook'." (interactive) @@ -361,7 +361,7 @@ Tab indents for C code. Comments start with -- and end with newline or another --. Delete converts tabs to spaces as it moves back. \\{snmp-mode-map} -Turning on snmp-mode runs the hooks in `snmp-common-mode-hook', +Turning on `snmp-mode' runs the hooks in `snmp-common-mode-hook', then `snmpv2-mode-hook'." (interactive) diff --git a/lisp/net/socks.el b/lisp/net/socks.el index 78a261fd83e..7ac8bbbf1be 100644 --- a/lisp/net/socks.el +++ b/lisp/net/socks.el @@ -453,7 +453,7 @@ When ATYPE indicates an IP, param ADDRESS must be given as raw bytes." ;; Replacement functions for open-network-stream, etc. (defvar socks-noproxy nil - "List of regexps matching hosts that we should not socksify connections to") + "List of regexps matching hosts that we should not socksify connections to.") (defun socks-find-route (host _service) (let ((route socks-server) diff --git a/lisp/net/telnet.el b/lisp/net/telnet.el index bb65ecaa981..9aa5d50d6c1 100644 --- a/lisp/net/telnet.el +++ b/lisp/net/telnet.el @@ -83,8 +83,9 @@ LOGIN-NAME, which is optional, says what to log in as on that machine.") "Program to run to open a telnet connection.") (defvar telnet-initial-count -50 - "Initial value of `telnet-count'. Should be set to the negative of the -number of terminal writes telnet will make setting up the host connection.") + "Initial value of `telnet-count'. +Should be set to the negative of the number of terminal writes +telnet will make setting up the host connection.") (defvar telnet-maximum-count 4 "Maximum value `telnet-count' can have. diff --git a/lisp/net/tramp-sh.el b/lisp/net/tramp-sh.el index 22d4712985c..0416d15f521 100644 --- a/lisp/net/tramp-sh.el +++ b/lisp/net/tramp-sh.el @@ -5800,8 +5800,8 @@ This command is returned only if `delete-by-moving-to-trash' is non-nil." ;; Some predefined connection properties. (defun tramp-get-inline-compress (vec prop size) "Return the compress command related to PROP. -PROP is either `inline-compress' or `inline-decompress'. SIZE is -the length of the file to be compressed. +PROP is either `inline-compress' or `inline-decompress'. +SIZE is the length of the file to be compressed. If no corresponding command is found, nil is returned." (when (and (integerp tramp-inline-compress-start-size) diff --git a/lisp/net/tramp.el b/lisp/net/tramp.el index 6ed67034f4e..93ec8d69340 100644 --- a/lisp/net/tramp.el +++ b/lisp/net/tramp.el @@ -1929,7 +1929,7 @@ The outline level is equal to the verbosity of the Tramp message." (put #'tramp-trace-buffer-name 'tramp-suppress-trace t) (defvar tramp-trace-functions nil - "A list of non-Tramp functions to be traced with tramp-verbose > 10.") + "A list of non-Tramp functions to be traced with `tramp-verbose' > 10.") (defun tramp-debug-message (vec fmt-string &rest arguments) "Append message to debug buffer of VEC. diff --git a/lisp/net/zeroconf.el b/lisp/net/zeroconf.el index d5da73bd857..98be0e0158e 100644 --- a/lisp/net/zeroconf.el +++ b/lisp/net/zeroconf.el @@ -104,7 +104,7 @@ (require 'dbus) (defvar zeroconf-debug nil - "Write messages during service discovery") + "Write messages during service discovery.") (defconst zeroconf-service-avahi "org.freedesktop.Avahi" "The D-Bus name used to talk to Avahi.") @@ -375,7 +375,7 @@ type used when registering FUNCTION." (defun zeroconf-get-service (name type) "Return the service description of service NAME as list. NAME must be a string. The service must be of service type -TYPE. The resulting list has the format +TYPE. The resulting list has the format (INTERFACE PROTOCOL NAME TYPE DOMAIN FLAGS)." ;; Due to the service browser, all known services are kept in @@ -387,7 +387,7 @@ TYPE. The resulting list has the format (defun zeroconf-resolve-service (service) "Return all service attributes SERVICE as list. NAME must be a string. The service must be of service type -TYPE. The resulting list has the format +TYPE. The resulting list has the format (INTERFACE PROTOCOL NAME TYPE DOMAIN HOST APROTOCOL ADDRESS PORT TXT FLAGS)." (let* ((name (zeroconf-service-name service)) diff --git a/lisp/newcomment.el b/lisp/newcomment.el index b458f0356de..52e7f09b693 100644 --- a/lisp/newcomment.el +++ b/lisp/newcomment.el @@ -161,11 +161,11 @@ comments always start in column zero.") (defvar-local comment-combine-change-calls t "If non-nil (the default), use `combine-change-calls' around - calls of `comment-region-function' and - `uncomment-region-function'. This Substitutes a single call to - each of the hooks `before-change-functions' and - `after-change-functions' in place of those hooks being called - for each individual buffer change.") +calls of `comment-region-function' and +`uncomment-region-function'. This Substitutes a single call to +each of the hooks `before-change-functions' and +`after-change-functions' in place of those hooks being called +for each individual buffer change.") (defvar comment-region-function 'comment-region-default "Function to comment a region. diff --git a/lisp/notifications.el b/lisp/notifications.el index ebd74dd3ef2..c1b83dc1555 100644 --- a/lisp/notifications.el +++ b/lisp/notifications.el @@ -168,7 +168,7 @@ Various PARAMS can be set: :sound-file The path to a sound file to play when the notification pops up. :sound-name A themable named sound from the freedesktop.org sound naming specification to play when the notification pops up. - Similar to icon-name,only for sounds. An example would + Similar to icon-name, only for sounds. An example would be \"message-new-instant\". :suppress-sound Causes the server to suppress playing any sounds, if it has that ability. diff --git a/lisp/nxml/nxml-mode.el b/lisp/nxml/nxml-mode.el index 405f803325c..c5c9dfb2afc 100644 --- a/lisp/nxml/nxml-mode.el +++ b/lisp/nxml/nxml-mode.el @@ -106,9 +106,10 @@ nor UTF-8." (defcustom nxml-prefer-utf-16-little-to-big-endian-flag (eq system-type 'windows-nt) "Non-nil means prefer little-endian to big-endian byte-order for UTF-16. -This is used only for saving a buffer; when reading the byte-order is -auto-detected. It may be relevant both when there is no encoding declaration -and when the encoding declaration specifies `UTF-16'." +This is used only for saving a buffer; when reading the +byte-order is auto-detected. It may be relevant both when there +is no encoding declaration and when the encoding declaration +specifies `UTF-16'." :group 'nxml :type 'boolean :safe #'booleanp) @@ -392,11 +393,11 @@ reference.") (define-key map "/" 'nxml-electric-slash) (define-key map "\M-\t" 'completion-at-point) map) - "Keymap for nxml-mode.") + "Keymap for `nxml-mode'.") (defvar nxml-font-lock-keywords '(nxml-fontify-matcher) - "Default font lock keywords for nxml-mode.") + "Default font lock keywords for `nxml-mode'.") (defsubst nxml-set-face (start end face) (when (and face (< start end)) @@ -576,7 +577,7 @@ Many aspects this mode can be customized using string) (defun nxml-cleanup () - "Clean up after nxml-mode." + "Clean up after `nxml-mode'." ;; Disable associated minor modes. (rng-validate-mode -1) ;; Clean up fontification. @@ -2269,7 +2270,7 @@ ENDP is t in the former case, nil in the latter." (defun nxml-dynamic-markup-word () "Dynamically markup the word before point. This attempts to find a tag to put around the word before point based -on the contents of the current buffer. The end-tag will be inserted at +on the contents of the current buffer. The end-tag will be inserted at point. The start-tag will be inserted at or before the beginning of the word before point; the contents of the current buffer is used to decide where. diff --git a/lisp/nxml/nxml-ns.el b/lisp/nxml/nxml-ns.el index e33140c0a48..93ffb215fb7 100644 --- a/lisp/nxml/nxml-ns.el +++ b/lisp/nxml/nxml-ns.el @@ -95,7 +95,7 @@ Return nil if there is no default namespace." (caar nxml-ns-state)) (defun nxml-ns-set-default (ns) - "Changes the current default namespace. + "Change the current default namespace. The change will be in effect until the end of the current element. NS is a symbol or nil." (setq nxml-ns-state diff --git a/lisp/nxml/nxml-outln.el b/lisp/nxml/nxml-outln.el index c265b19cf05..681b297b489 100644 --- a/lisp/nxml/nxml-outln.el +++ b/lisp/nxml/nxml-outln.el @@ -40,7 +40,7 @@ ;; For state 3 it is t. ;; The special display is achieved by using overlays. The overlays ;; are computed from the nxml-outline-state property by -;; `nxml-refresh-outline'. There overlays all have a category property +;; `nxml-refresh-outline'. There overlays all have a category property ;; with an nxml-outline-display property with value t. ;; ;; For a section to be recognized as such, the following conditions must @@ -445,7 +445,7 @@ non-transparent child section." (cond ((not (nxml-section-tag-forward)) (if (null tag-qnames) nil - (nxml-outline-error "missing end-tag %s" + (nxml-outline-error "Missing end-tag %s" (car tag-qnames)))) ;; section end-tag ((nxml-token-end-tag-p) @@ -455,9 +455,9 @@ non-transparent child section." xmltok-start)) (let ((qname (xmltok-end-tag-qname))) (unless tag-qnames - (nxml-outline-error "extra end-tag %s" qname)) + (nxml-outline-error "Extra end-tag %s" qname)) (unless (string= (car tag-qnames) qname) - (nxml-outline-error "mismatched end-tag; expected %s, got %s" + (nxml-outline-error "Mismatched end-tag; expected %s, got %s" (car tag-qnames) qname))) (cond ((> transparent-depth 0) @@ -938,7 +938,7 @@ If unbalanced section tags are found, signal an `nxml-outline-error'." (setq found t)) (let ((qname (xmltok-start-tag-qname))) (unless (string= (car open-tags) qname) - (nxml-outline-error "mismatched end-tag")) + (nxml-outline-error "Mismatched end-tag")) (setq open-tags (cdr open-tags))))) (goto-char section-start-pos) (and (not found) diff --git a/lisp/nxml/nxml-rap.el b/lisp/nxml/nxml-rap.el index 6f742746e9e..fa127da8749 100644 --- a/lisp/nxml/nxml-rap.el +++ b/lisp/nxml/nxml-rap.el @@ -22,14 +22,14 @@ ;;; Commentary: -;; This uses xmltok.el to do XML parsing. The fundamental problem is -;; how to handle changes. We don't want to maintain a complete parse +;; This uses xmltok.el to do XML parsing. The fundamental problem is +;; how to handle changes. We don't want to maintain a complete parse ;; tree. We also don't want to reparse from the start of the document ;; on every keystroke. However, it is not possible in general to ;; parse an XML document correctly starting at a random point in the ;; middle. The main problems are comments, CDATA sections and ;; processing instructions: these can all contain things that are -;; indistinguishable from elements. Literals in the prolog are also a +;; indistinguishable from elements. Literals in the prolog are also a ;; problem. Attribute value literals are not a problem because ;; attribute value literals cannot contain less-than signs. ;; @@ -47,14 +47,14 @@ ;; we have found. ;; ;; The prolog has to be parsed specially, so we also keep track of the -;; end of the prolog in `nxml-prolog-end'. The prolog is reparsed on +;; end of the prolog in `nxml-prolog-end'. The prolog is reparsed on ;; every change to the prolog. This won't work well if people try to -;; edit huge internal subsets. Hopefully that will be rare. +;; edit huge internal subsets. Hopefully that will be rare. ;; ;; We rely on the `syntax-propertize-function' machinery to keep track ;; of the changes in the buffer. Fontification also relies on correct ;; `syntax-table' properties. This means that scanning for these -;; constructs had better be quick. Fortunately it is. Firstly, the +;; constructs had better be quick. Fortunately it is. Firstly, the ;; typical proportion of comments, CDATA sections and processing ;; instructions is small relative to other things. Secondly, to scan ;; we just search for the regexp <[!?]. @@ -191,7 +191,7 @@ Leave point unmoved if it is not inside anything special." (defun nxml-scan-element-forward (from &optional up) "Scan forward from FROM over a single balanced element. Point must be between tokens. Return the position of the end of -the tag that ends the element. `xmltok-start' will contain the +the tag that ends the element. `xmltok-start' will contain the position of the start of the tag. If UP is non-nil, then scan past end-tag of element containing point. If no element is found, return nil. If a well-formedness error prevents scanning, @@ -242,7 +242,7 @@ expected `%s'" (defun nxml-scan-element-backward (from &optional up bound) "Scan backward from FROM over a single balanced element. Point must be between tokens. Return the position of the end of -the tag that starts the element. `xmltok-start' will contain the +the tag that starts the element. `xmltok-start' will contain the position of the start of the tag. If UP is non-nil, then scan past start-tag of element containing point. If BOUND is non-nil, then don't scan back past BOUND. If no element is found, return diff --git a/lisp/nxml/rng-nxml.el b/lisp/nxml/rng-nxml.el index d70a346159a..35faae3062c 100644 --- a/lisp/nxml/rng-nxml.el +++ b/lisp/nxml/rng-nxml.el @@ -35,7 +35,7 @@ (require 'sgml-mode) (defcustom rng-nxml-auto-validate-flag t - "Non-nil means automatically turn on validation with nxml-mode." + "Non-nil means automatically turn on validation with `nxml-mode'." :type 'boolean :group 'relax-ng) diff --git a/lisp/nxml/rng-valid.el b/lisp/nxml/rng-valid.el index a5eb893c554..fca666115a2 100644 --- a/lisp/nxml/rng-valid.el +++ b/lisp/nxml/rng-valid.el @@ -25,15 +25,15 @@ ;; For usage information, see the documentation for rng-validate-mode. ;; ;; This file provides a minor mode that continually validates a buffer -;; against a RELAX NG schema. The validation state is used to support -;; schema-sensitive editing as well as validation. Validation is +;; against a RELAX NG schema. The validation state is used to support +;; schema-sensitive editing as well as validation. Validation is ;; performed while Emacs is idle. XML parsing is done using -;; xmltok.el. This file is responsible for checking that end-tags +;; xmltok.el. This file is responsible for checking that end-tags ;; match their start-tags. Namespace processing is handled by -;; nxml-ns.el. The RELAX NG Compact Syntax schema is parsed into +;; nxml-ns.el. The RELAX NG Compact Syntax schema is parsed into ;; internal form by rng-cmpct.el. This internal form is described by ;; rng-pttrn.el. Validation of the document by matching against this -;; internal form is done by rng-match.el. Handling of W3C XML Schema +;; internal form is done by rng-match.el. Handling of W3C XML Schema ;; datatypes is delegated by rng-match.el to rng-xsd.el. The minor ;; mode is intended to be used in conjunction with the nxml major ;; mode, but does not have to be. @@ -44,11 +44,11 @@ ;; parse and validate it from start to end. As we parse and validate ;; the buffer, we periodically cache the state. The state has three ;; components: the stack of open elements, the namespace processing -;; state and the RELAX NG validation state. The state is cached as the +;; state and the RELAX NG validation state. The state is cached as the ;; value of the rng-state text property on the closing greater-than of ;; tags (but at intervals, not on every tag). We keep track of the ;; position up to which cached state is known to be correct by adding -;; a function to the buffer's after-change-functions. This is stored +;; a function to the buffer's after-change-functions. This is stored ;; in the rng-validate-up-to-date-end variable. The first way in ;; which we make validation incremental is obvious: we start ;; validation from the first cached state before @@ -59,7 +59,7 @@ ;; minimizing destructive changes to the objects storing the state. ;; When state is changed, we use the old state to create new objects ;; representing the new state rather than destructively modifying the -;; objects representing the old state. Copying the state is just a +;; objects representing the old state. Copying the state is just a ;; matter of making a list of three objects, one for each component of ;; the state; the three objects themselves can be shared and do not ;; need to be copied. @@ -261,7 +261,7 @@ to use for finding the schema." (remove-hook 'after-change-functions #'rng-after-change-function t)))) (defun rng-set-schema-file-and-validate (filename) - "Sets the schema and turns on `rng-validate-mode' if not already on. + "Set the schema and turn on `rng-validate-mode' if not already on. The schema is set like `rng-set-schema'." (interactive "fSchema file: ") (rng-set-schema-file filename) diff --git a/lisp/nxml/rng-xsd.el b/lisp/nxml/rng-xsd.el index 9941aba6eb1..e4c76b220ae 100644 --- a/lisp/nxml/rng-xsd.el +++ b/lisp/nxml/rng-xsd.el @@ -22,7 +22,7 @@ ;;; Commentary: -;; The main entry point is `rng-xsd-compile'. The validator +;; The main entry point is `rng-xsd-compile'. The validator ;; knows to use this for the datatype library with URI ;; https://www.w3.org/2001/XMLSchema-datatypes because it ;; is the value of the rng-dt-compile property on that URI diff --git a/lisp/nxml/xmltok.el b/lisp/nxml/xmltok.el index 38bc2e141e6..6159e00c511 100644 --- a/lisp/nxml/xmltok.el +++ b/lisp/nxml/xmltok.el @@ -22,13 +22,13 @@ ;;; Commentary: -;; This implements an XML 1.0 parser. It also implements the XML +;; This implements an XML 1.0 parser. It also implements the XML ;; Namespaces Recommendation. It is designed to be conforming, but it -;; works a bit differently from a normal XML parser. An XML document +;; works a bit differently from a normal XML parser. An XML document ;; consists of the prolog and an instance. The prolog is parsed as a ;; single unit using `xmltok-forward-prolog'. The instance is ;; considered as a sequence of tokens, where a token is something like -;; a start-tag, a comment, a chunk of data or a CDATA section. The +;; a start-tag, a comment, a chunk of data or a CDATA section. The ;; tokenization of the instance is stateless: the tokenization of one ;; part of the instance does not depend on tokenization of the ;; preceding part of the instance. This allows the instance to be @@ -70,7 +70,7 @@ ;; value literals specifying default attribute values, and default ;; attribute values are not reported to the client. ;; -;; 2. It does not implement internal entities containing elements. If +;; 2. It does not implement internal entities containing elements. If ;; an internal entity is referenced and parsing its replacement text ;; yields one or more tags, then it will skip the reference and ;; report this to the client. diff --git a/lisp/pixel-scroll.el b/lisp/pixel-scroll.el index 78b8259b395..249484cf581 100644 --- a/lisp/pixel-scroll.el +++ b/lisp/pixel-scroll.el @@ -296,9 +296,9 @@ unseen line above the first line, respectively, is provided." (defun pixel-visible-pos-in-window () "Return position shown on text line where cursor is in the selected window. -This will look for positions of point and end-of-visual-line, -then positions from beginning-of-visual-line to -end-of-visual-line. When no char in a line is shown, this +This will look for positions of point and `end-of-visual-line', +then positions from `beginning-of-visual-line' to +`end-of-visual-line'. When no char in a line is shown, this returns nil." (let* ((beginning-of-visual-line-pos (save-excursion (beginning-of-visual-line) (point))) (end-of-visual-line-pos (save-excursion (end-of-visual-line) (point))) diff --git a/lisp/play/5x5.el b/lisp/play/5x5.el index 64d43c3d480..1d193306296 100644 --- a/lisp/play/5x5.el +++ b/lisp/play/5x5.el @@ -443,8 +443,9 @@ should return a grid vector array that is the new solution." solution) (defun 5x5-play-solution (solution best) - "Play a solution on an empty grid. This destroys the current game -in progress because it is an animated attempt." + "Play a solution on an empty grid. +This destroys the current game in progress because it is an +animated attempt." (5x5-new-game) (let ((inhibit-quit t)) (dotimes (y 5x5-grid-size) @@ -802,7 +803,7 @@ there are 4 possible solutions. When function `5x5-solve-suggest' (press `\\[5x5-solve-suggest]') is called the solution that is presented is the one that needs least number of strokes --- other solutions can be viewed by rotating through the -list. The list of solution is ordered by number of strokes, so +list. The list of solution is ordered by number of strokes, so rotating left just after calling `5x5-solve-suggest' will show the solution with second least number of strokes, while rotating right will show the solution with greatest number of strokes." diff --git a/lisp/play/cookie1.el b/lisp/play/cookie1.el index be35daf4da8..d1bf45ed510 100644 --- a/lisp/play/cookie1.el +++ b/lisp/play/cookie1.el @@ -110,7 +110,7 @@ of load, ENDMSG at the end." (fill-region-as-paragraph start (point) nil)))) (defun cookie1 (arg cookie-vec) - "Inserts a cookie phrase ARG times." + "Insert a cookie phrase ARG times." (cond ((zerop arg) t) (t (insert (aref cookie-vec arg)) (insert " ") @@ -118,8 +118,8 @@ of load, ENDMSG at the end." ;;;###autoload (defun cookie-snarf (phrase-file &optional startmsg endmsg) - "Reads in the PHRASE-FILE, returns it as a vector of strings. -Emit STARTMSG and ENDMSG before and after. Caches the result; second + "Read the PHRASE-FILE, return it as a vector of strings. +Emit STARTMSG and ENDMSG before and after. Cache the result; second and subsequent calls on the same file won't go to disk." (setq phrase-file (cookie-check-file phrase-file)) (let ((sym (intern-soft phrase-file cookie-cache))) diff --git a/lisp/play/decipher.el b/lisp/play/decipher.el index a80cb21151f..5431d7f068a 100644 --- a/lisp/play/decipher.el +++ b/lisp/play/decipher.el @@ -177,7 +177,7 @@ the tail of the list." (modify-syntax-entry c "_" table) ;Digits are not part of words (cl-incf c)) table) - "Decipher mode syntax table") + "Decipher mode syntax table.") (defvar-local decipher-alphabet nil) ;; This is an alist containing entries (PLAIN-CHAR . CIPHER-CHAR), diff --git a/lisp/play/dunnet.el b/lisp/play/dunnet.el index 332e743ed8e..d9acad8e43e 100644 --- a/lisp/play/dunnet.el +++ b/lisp/play/dunnet.el @@ -2264,7 +2264,7 @@ except for the verb." result))) (defun dun-get-path (dirstring startlist) - "Given a unix style pathname, build a list of path components (recursive)" + "Given a unix style pathname, build a list of path components (recursive)." (let (slash) (if (= (length dirstring) 0) startlist diff --git a/lisp/play/fortune.el b/lisp/play/fortune.el index fb02edffe73..f13302525b3 100644 --- a/lisp/play/fortune.el +++ b/lisp/play/fortune.el @@ -142,7 +142,7 @@ No need to add an `in'." ;;; ************** ;;; Inserting a new fortune (defun fortune-append (string &optional interactive file) - "Appends STRING to the fortune FILE. + "Append STRING to the fortune FILE. If INTERACTIVE is non-nil, don't compile the fortune file afterwards." (setq file (expand-file-name diff --git a/lisp/play/gamegrid.el b/lisp/play/gamegrid.el index 8b64dfdf9b5..49a0c9ee02b 100644 --- a/lisp/play/gamegrid.el +++ b/lisp/play/gamegrid.el @@ -490,7 +490,7 @@ format." "Add the current score to the high score file. If REVERSE is non-nil, treat lower scores as better than higher -scores. This is useful for games where lower scores are better. +scores. This is useful for games where lower scores are better. On POSIX systems there may be a shared game directory for all users in which the scorefiles are kept. On such systems Emacs doesn't create diff --git a/lisp/play/gametree.el b/lisp/play/gametree.el index c6aef027e5f..cc9a6b7a4f0 100644 --- a/lisp/play/gametree.el +++ b/lisp/play/gametree.el @@ -508,7 +508,7 @@ being entered automatically (and thus should lack the manual mark)." (insert (int-to-string (prefix-numeric-value score)))))) (defun gametree-compute-and-insert-score () - "Compute current node score, maybe recursively from subnodes. Insert it. + "Compute current node score, maybe recursively from subnodes. Insert it. Subnodes which have been manually scored are honored." (interactive "*") (let ((auto (not (and (looking-at gametree-score-regexp) diff --git a/lisp/play/handwrite.el b/lisp/play/handwrite.el index 2aec408e11b..d59352c3529 100644 --- a/lisp/play/handwrite.el +++ b/lisp/play/handwrite.el @@ -139,7 +139,7 @@ ;;;###autoload (defun handwrite () - "Turns the buffer into a \"handwritten\" document. + "Turn the buffer into a \"handwritten\" document. The functions `handwrite-10pt', `handwrite-11pt', `handwrite-12pt' and `handwrite-13pt' set up for various sizes of output. diff --git a/lisp/play/hanoi.el b/lisp/play/hanoi.el index ac28fba10a4..d3d0ad1309c 100644 --- a/lisp/play/hanoi.el +++ b/lisp/play/hanoi.el @@ -70,7 +70,7 @@ :group 'games) (defcustom hanoi-horizontal-flag nil - "If non-nil, hanoi poles are oriented horizontally." + "Non-nil means that hanoi poles are oriented horizontally." :type 'boolean) (defcustom hanoi-move-period 1.0 @@ -131,7 +131,7 @@ Repent before ring 31 moves." ;;;###autoload (defun hanoi-unix-64 () - "Like hanoi-unix, but pretend to have a 64-bit clock. + "Like `hanoi-unix', but pretend to have a 64-bit clock. This is, necessarily (as of Emacs 20.3), a crock. When the current-time interface is made s2G-compliant, hanoi.el will need to be updated." @@ -284,7 +284,7 @@ BITS must be of length nrings. Start at START-TIME." (force-mode-line-update))) (defun hanoi-put-face (start end value &optional object) - "If hanoi-use-faces is non-nil, call put-text-property for face property." + "If `hanoi-use-faces' is non-nil, call `put-text-property' for face property." (if hanoi-use-faces (put-text-property start end 'face value object))) diff --git a/lisp/play/life.el b/lisp/play/life.el index 2abf8ccb74b..2bf72927723 100644 --- a/lisp/play/life.el +++ b/lisp/play/life.el @@ -136,10 +136,10 @@ (defvar life-window-start nil) (defvar life--max-width nil - "If non-nil, restrict width to this positive integer. ") + "If non-nil, restrict width to this positive integer.") (defvar life--max-height nil - "If non-nil, restrict height to this positive integer. ") + "If non-nil, restrict height to this positive integer.") ;; For mode line (defvar life-current-generation nil) diff --git a/lisp/play/mpuz.el b/lisp/play/mpuz.el index 123cc3cfacb..5ac1d7c60c2 100644 --- a/lisp/play/mpuz.el +++ b/lisp/play/mpuz.el @@ -99,7 +99,7 @@ You may enter a guess for a letter's value by typing first the letter, then the digit. Thus, to guess that A=3, type `A 3'. To leave the game to do other editing work, just switch buffers. -Then you may resume the game with M-x mpuz. +Then you may resume the game with \\[mpuz]. You may abort a game by typing \\\\[mpuz-offer-abort]." (setq tab-width 30)) diff --git a/lisp/play/spook.el b/lisp/play/spook.el index d0669eb1f46..69f444994f5 100644 --- a/lisp/play/spook.el +++ b/lisp/play/spook.el @@ -53,7 +53,7 @@ ;;;###autoload (defun spook () - "Adds that special touch of class to your outgoing mail." + "Add that special touch of class to your outgoing mail." (interactive) (cookie-insert spook-phrases-file spook-phrase-default-count diff --git a/lisp/play/zone.el b/lisp/play/zone.el index 19e4e399ff3..27aa48f4c9a 100644 --- a/lisp/play/zone.el +++ b/lisp/play/zone.el @@ -99,7 +99,7 @@ If the element is a function or a list of a function and a number, (functionp (car elem)) (numberp (cadr elem))) (apply 'zone-call elem)) - (t (error "bad `zone-call' elem: %S" elem)))) + (t (error "Bad `zone-call' elem: %S" elem)))) program)))) ;;;###autoload diff --git a/lisp/plstore.el b/lisp/plstore.el index 4ca5886bf15..bcca637e00a 100644 --- a/lisp/plstore.el +++ b/lisp/plstore.el @@ -83,7 +83,7 @@ (require 'epg) (defgroup plstore nil - "Searchable, partially encrypted, persistent plist store" + "Searchable, partially encrypted, persistent plist store." :version "24.1" :group 'files) diff --git a/lisp/printing.el b/lisp/printing.el index 7587676ab27..32ff51a511f 100644 --- a/lisp/printing.el +++ b/lisp/printing.el @@ -1403,7 +1403,7 @@ The printer name symbol should be defined on `pr-txt-printer-alist' (see it for documentation). This variable should be modified by customization engine. If this variable is -modified by other means (for example, a lisp function), use `pr-update-menus' +modified by other means (for example, a Lisp function), use `pr-update-menus' function (see it for documentation) to update text printer menu." :type 'symbol :set 'pr-txt-name-custom-set) @@ -1489,7 +1489,7 @@ NAME A string that specifies a text printer name. \"share-name\" This variable should be modified by customization engine. If this variable is -modified by other means (for example, a lisp function), use `pr-update-menus' +modified by other means (for example, a Lisp function), use `pr-update-menus' function (see it for documentation) to update text printer menu. Examples: @@ -1544,7 +1544,7 @@ This printer name symbol should be defined on `pr-ps-printer-alist' (see it for documentation). This variable should be modified by customization engine. If this variable is -modified by other means (for example, a lisp function), use `pr-update-menus' +modified by other means (for example, a Lisp function), use `pr-update-menus' function (see it for documentation) to update PostScript printer menu." :type 'symbol :set 'pr-ps-name-custom-set) @@ -2246,7 +2246,7 @@ This utility symbol should be defined on `pr-ps-utility-alist' (see it for documentation). This variable should be modified by customization engine. If this variable is -modified by other means (for example, a lisp function), use `pr-update-menus' +modified by other means (for example, a Lisp function), use `pr-update-menus' function (see it for documentation) to update PostScript utility menu. NOTE: Don't forget to download and install the utilities declared on @@ -2560,7 +2560,7 @@ SETTING It's a cons like: * If LOCAL is nil: (set VARIABLE (eval VALUE)) - Note that VALUE can be any valid lisp expression. So, don't + Note that VALUE can be any valid Lisp expression. So, don't forget to quote symbols and constant lists. This setting is ignored if VARIABLE is equal to keyword `inherits-from:'. @@ -2672,7 +2672,7 @@ happens when printing: "Non-nil means list directory when processing a directory. That is, any subdirectories (and the superdirectory) of the directory (given as -argument of functions below) are also printed (as dired-mode listings). +argument of functions below) are also printed (as `dired-mode' listings). It's used by `pr-ps-directory-preview', `pr-ps-directory-using-ghostscript', `pr-ps-directory-print', `pr-ps-directory-ps-print', `pr-printify-directory' @@ -5577,7 +5577,7 @@ COMMAND.exe, COMMAND.bat and COMMAND.com in this order." (define-key map "q" 'pr-interface-quit) (define-key map "?" 'pr-interface-help) map) - "Keymap for pr-interface.") + "Keymap for `pr-interface'.") (defmacro pr-interface-save (&rest body) `(with-current-buffer pr-i-buffer @@ -5933,7 +5933,7 @@ COMMAND.exe, COMMAND.bat and COMMAND.com in this order." (defun pr-interface-help (&rest _ignore) - "printing buffer interface help." + "Printing buffer interface help." (interactive) (pr-show-setup pr-interface-help-message "*Printing Interface Help*")) diff --git a/lisp/proced.el b/lisp/proced.el index 2fafdcc58e5..fec2a29c847 100644 --- a/lisp/proced.el +++ b/lisp/proced.el @@ -32,7 +32,7 @@ ;; - Allow "sudo kill PID", "sudo renice PID" ;; `proced-send-signal' operates on multiple processes one by one. ;; With "sudo" we want to execute one "kill" or "renice" command -;; for all marked processes. Is there a `sudo-call-process'? +;; for all marked processes. Is there a `sudo-call-process'? ;; ;; Thoughts and Ideas ;; - Currently, `process-attributes' returns the list of @@ -497,8 +497,8 @@ Important: the match ends just after the marker.") km) "Keymap for Proced commands.") -(easy-menu-define - proced-menu proced-mode-map "Proced Menu" +(easy-menu-define proced-menu proced-mode-map + "Proced Menu." `("Proced" ["Mark" proced-mark :help "Mark Current Process"] diff --git a/lisp/profiler.el b/lisp/profiler.el index 4c427692cb8..0b456bb3e31 100644 --- a/lisp/profiler.el +++ b/lisp/profiler.el @@ -463,12 +463,12 @@ Optional argument MODE means only check for the specified mode (cpu or mem)." "The current profile.") (defvar-local profiler-report-reversed nil - "True if calltree is rendered in bottom-up. Do not touch this -variable directly.") + "True if calltree is rendered in bottom-up. +Do not touch this variable directly.") (defvar-local profiler-report-order nil - "The value can be `ascending' or `descending'. Do not touch -this variable directly.") + "The value can be `ascending' or `descending'. +Do not touch this variable directly.") (defun profiler-report-make-entry-part (entry) (let ((string (cond @@ -618,8 +618,7 @@ RET: expand or collapse")) buffer)) (defun profiler-report-setup-buffer (profile) - "Make a buffer for PROFILE with rendering the profile and -return it." + "Make a buffer for PROFILE with rendering the profile and return it." (let ((buffer (profiler-report-setup-buffer-1 profile))) (with-current-buffer buffer (profiler-report-render-calltree)) @@ -706,9 +705,9 @@ With a prefix argument, expand the whole subtree." t))) (defun profiler-report-toggle-entry (&optional arg) - "Expand entry at point if the tree is collapsed, -otherwise collapse. With prefix argument, expand all subentries -below entry at point." + "Expand entry at point if the tree is collapsed, otherwise collapse. +With prefix argument, expand all subentries below entry at +point." (interactive "P") (or (profiler-report-expand-entry arg) (profiler-report-collapse-entry))) diff --git a/lisp/progmodes/cc-align.el b/lisp/progmodes/cc-align.el index 9234d0b19b9..a26c1d5bff9 100644 --- a/lisp/progmodes/cc-align.el +++ b/lisp/progmodes/cc-align.el @@ -914,7 +914,7 @@ Works with: template-args-cont." (defun c-lineup-ObjC-method-call (langelem) "Line up selector args as Emacs Lisp mode does with function args: Go to the position right after the message receiver, and if you are at -the end of the line, indent the current line c-basic-offset columns +the end of the line, indent the current line `c-basic-offset' columns from the opening bracket; otherwise you are looking at the first character of the first method call argument, so line up the current line with it. @@ -943,9 +943,9 @@ Works with: objc-method-call-cont." (defun c-lineup-ObjC-method-call-colons (langelem) "Line up selector args as Project Builder / XCode: colons of first - selector portions on successive lines are aligned. If no decision can - be made return NIL, so that other lineup methods can be tried. This is - typically chained with `c-lineup-ObjC-method-call'. +selector portions on successive lines are aligned. If no decision can +be made return NIL, so that other lineup methods can be tried. This is +typically chained with `c-lineup-ObjC-method-call'. Works with: objc-method-call-cont." (save-excursion diff --git a/lisp/progmodes/cc-awk.el b/lisp/progmodes/cc-awk.el index f1bc25db7f7..ea991017508 100644 --- a/lisp/progmodes/cc-awk.el +++ b/lisp/progmodes/cc-awk.el @@ -1095,9 +1095,10 @@ std\\(err\\|in\\|out\\)\\|user\\)\\)\\>\ "[#\n\r]")))))))) (defun c-awk-beginning-of-defun (&optional arg) - "Move backward to the beginning of an AWK \"defun\". With ARG, do it that -many times. Negative arg -N means move forward to Nth following beginning of -defun. Returns t unless search stops due to beginning or end of buffer. + "Move backward to the beginning of an AWK \"defun\". +With ARG, do it that many times. Negative arg -N means move +forward to Nth following beginning of defun. Returns t unless +search stops due to beginning or end of buffer. By a \"defun\" is meant either a pattern-action pair or a function. The start of a defun is recognized as code starting at column zero which is neither a diff --git a/lisp/progmodes/cc-bytecomp.el b/lisp/progmodes/cc-bytecomp.el index edbac64eadb..f07f18678a2 100644 --- a/lisp/progmodes/cc-bytecomp.el +++ b/lisp/progmodes/cc-bytecomp.el @@ -381,7 +381,7 @@ afterwards. Don't use within `eval-when-compile'." (eval-when-compile (cc-bytecomp-setup-environment)))) (defmacro cc-bytecomp-defvar (var) - "Binds the symbol as a variable during compilation of the file, + "Bind the symbol as a variable during compilation of the file, to silence the byte compiler. Don't use within `eval-when-compile'." (declare (debug nil)) `(eval-when-compile diff --git a/lisp/progmodes/cc-cmds.el b/lisp/progmodes/cc-cmds.el index bdfdf178d43..217281b8a24 100644 --- a/lisp/progmodes/cc-cmds.el +++ b/lisp/progmodes/cc-cmds.el @@ -497,7 +497,7 @@ function to control that." (defvar c--unsafe-post-self-insert-hook-functions '(electric-pair-post-self-insert-function) - "Known unsafe functions when members of `post-self-insert-hook' in CC Mode") + "Known unsafe functions when members of `post-self-insert-hook' in CC Mode.") (defun c--call-post-self-insert-hook-more-safely-1 () ;; Call post-self-insert-hook, having removed from `post-self-insert-hook' @@ -2059,7 +2059,7 @@ the open-parenthesis that starts a defun; see `beginning-of-defun'." (defun c-defun-name-1 () "Return the name of the current defun, at the current narrowing, -or NIL if there isn't one. \"Defun\" here means a function, or +or nil if there isn't one. \"Defun\" here means a function, or other top level construct with a brace block." (c-save-buffer-state (beginning-of-defun-function end-of-defun-function @@ -3383,12 +3383,12 @@ directives." (defun c-backward-conditional (count &optional target-depth with-else) "Move back across a preprocessor conditional, leaving mark behind. -A prefix argument acts as a repeat count. With a negative argument, +A prefix argument acts as a repeat COUNT. With a negative argument, move forward across a preprocessor conditional. The optional arguments TARGET-DEPTH and WITH-ELSE are historical, and have the same meanings as in `c-scan-conditionals'. If you -are calling c-forward-conditional from a program, you might want +are calling `c-forward-conditional' from a program, you might want to call `c-scan-conditionals' directly instead." (interactive "p") (let ((new-point (c-scan-conditionals (- count) target-depth with-else))) diff --git a/lisp/progmodes/cc-defs.el b/lisp/progmodes/cc-defs.el index fe6ff220baf..be0b40fd6c2 100644 --- a/lisp/progmodes/cc-defs.el +++ b/lisp/progmodes/cc-defs.el @@ -1385,7 +1385,7 @@ point is then left undefined." "Remove all text-properties PROPERTY from the region (FROM, TO) which have the value VALUE, as tested by `equal'. These properties are assumed to be over individual characters, having -been put there by c-put-char-property. POINT remains unchanged." +been put there by `c-put-char-property'. POINT remains unchanged." (let ((place from) end-place) (while ; loop round occurrences of (PROPERTY VALUE) (progn @@ -1406,7 +1406,7 @@ been put there by c-put-char-property. POINT remains unchanged." "Remove all text-properties PROPERTY from the region [FROM, TO) which have the value VALUE, as tested by `equal'. These properties are assumed to be over individual characters, having -been put there by c-put-char-property. POINT remains unchanged." +been put there by `c-put-char-property'. POINT remains unchanged." (declare (debug t)) (if c-use-extents ;; XEmacs diff --git a/lisp/progmodes/cc-engine.el b/lisp/progmodes/cc-engine.el index 77da98f6262..53c382f018c 100644 --- a/lisp/progmodes/cc-engine.el +++ b/lisp/progmodes/cc-engine.el @@ -1731,7 +1731,7 @@ Line continuations, i.e. a backslashes followed by line breaks, are treated as whitespace. The line breaks that end line comments are considered to be the comment enders, so the point cannot be at the end of the same line to move over a line comment. Unlike -c-backward-syntactic-ws, this function doesn't move back over +`c-backward-syntactic-ws', this function doesn't move back over preprocessor directives. Note that this function might do hidden buffer changes. See the @@ -3210,7 +3210,7 @@ comment at the start of cc-engine.el for more info." This function should be added to the `before-change-functions' hook by major modes that use CC Mode's filling functionality without initializing CC Mode. Currently (2020-06) these are -js-mode and mhtml-mode." +`js-mode' and `mhtml-mode'." (c-truncate-lit-pos-cache beg)) (defun c-foreign-init-lit-pos-cache () @@ -3218,8 +3218,8 @@ js-mode and mhtml-mode." This function should be called from the mode functions of major modes which use CC Mode's filling functionality without -initializing CC Mode. Currently (2020-06) these are js-mode and -mhtml-mode." +initializing CC Mode. Currently (2020-06) these are `js-mode' and +`mhtml-mode'." (c-truncate-lit-pos-cache 1)) @@ -7223,7 +7223,7 @@ comment at the start of cc-engine.el for more info." ;; the rest of the file is fontified normally. (defun c-ml-string-make-closer-re (_opener) - "Return c-ml-string-any-closer-re. + "Return `c-ml-string-any-closer-re'. This is a suitable language specific value of `c-make-ml-string-closer-re-function' for most languages with @@ -7231,7 +7231,7 @@ multi-line strings (but not C++, for example)." c-ml-string-any-closer-re) (defun c-ml-string-make-opener-re (_closer) - "Return c-ml-string-opener-re. + "Return `c-ml-string-opener-re'. This is a suitable language specific value of `c-make-ml-string-opener-re-function' for most languages with diff --git a/lisp/progmodes/cc-guess.el b/lisp/progmodes/cc-guess.el index 9c88c14a6c1..8f46b17c54d 100644 --- a/lisp/progmodes/cc-guess.el +++ b/lisp/progmodes/cc-guess.el @@ -34,18 +34,18 @@ ;; are some variants. ;; ;; Suppose the major mode for the current buffer is one of the modes -;; provided by cc-mode. `c-guess' guesses the indentation style by +;; provided by cc-mode. `c-guess' guesses the indentation style by ;; examining the indentation in the region between beginning of buffer ;; and `c-guess-region-max'. -;; and installs the guessed style. The name for installed style is given +;; and installs the guessed style. The name for installed style is given ;; by `c-guess-style-name'. ;; ;; `c-guess-buffer' does the same but in the whole buffer. ;; `c-guess-region' does the same but in the region between the point ;; and the mark. `c-guess-no-install', `c-guess-buffer-no-install' ;; and `c-guess-region-no-install' guess the indentation style but -;; don't install it. You can review a guessed style with `c-guess-view'. +;; don't install it. You can review a guessed style with `c-guess-view'. ;; After reviewing, use `c-guess-install' to install the style ;; if you prefer it. ;; @@ -56,11 +56,11 @@ ;; or implicitly with `c-guess', `c-guess-buffer', or `c-guess-region', ;; a style name is given by `c-guess-style-name' with the above form. ;; -;; If you want to reuse the guessed style in future emacs sessions, -;; you may want to put it to your .emacs. `c-guess-view' is for -;; you. It emits Emacs Lisp code which defines the last guessed -;; style, in a temporary buffer. You can put the emitted code into -;; your .emacs. This command was suggested by Alan Mackenzie. +;; If you want to reuse the guessed style in future Emacs sessions, +;; you may want to put it to your .emacs. `c-guess-view' is for +;; you. It emits Emacs Lisp code which defines the last guessed +;; style, in a temporary buffer. You can put the emitted code into +;; your .emacs. This command was suggested by Alan Mackenzie. ;;; Code: @@ -91,7 +91,7 @@ The offset of a line included in the indent information returned by (defcustom c-guess-region-max 50000 "The maximum region size for examining indent information with `c-guess'. It takes a long time to examine indent information from a large region; -this option helps you limit that time. nil means no limit." +this option helps you limit that time. nil means no limit." :version "24.1" :type 'integer :group 'c) @@ -465,7 +465,7 @@ the absolute file name of the file if STYLE-NAME is nil." (defun c-guess-dump-guessed-style (&optional printer) "Show the guessed style. `pp' is used to print the style but if PRINTER is given, -PRINTER is used instead. If PRINTER is not nil, it +PRINTER is used instead. If PRINTER is not nil, it is called with one argument, the guessed style." (interactive) (let ((style (c-guess-make-style c-guess-guessed-basic-offset diff --git a/lisp/progmodes/cc-langs.el b/lisp/progmodes/cc-langs.el index 0b125bc43fa..b106454b11e 100644 --- a/lisp/progmodes/cc-langs.el +++ b/lisp/progmodes/cc-langs.el @@ -151,10 +151,10 @@ c-emacs-variable-inits-tail c-emacs-variable-inits)) (defmacro c-lang-defvar (var val &optional doc) - "Declares the buffer local variable VAR to get the value VAL. VAL is -evaluated and assigned at mode initialization. More precisely, VAL is -evaluated and bound to VAR when the result from the macro -`c-init-language-vars' is evaluated. + "Declares the buffer local variable VAR to get the value VAL. +VAL is evaluated and assigned at mode initialization. More +precisely, VAL is evaluated and bound to VAR when the result from +the macro `c-init-language-vars' is evaluated. `c-lang-const' is typically used in VAL to get the right value for the language being initialized, and such calls will be macro expanded to @@ -184,8 +184,8 @@ the evaluated constant value at compile time." `',var) (defmacro c-lang-setvar (var val) - "Causes the variable VAR to be made buffer local and to get set to the -value VAL. VAL is evaluated and assigned at mode initialization. More + "Make variable VAR buffer local and set it to value VAL. +VAL is evaluated and assigned at mode initialization. More precisely, VAL is evaluated and bound to VAR when the result from the macro `c-init-language-vars' is evaluated. VAR is typically a standard Emacs variable like `comment-start'. diff --git a/lisp/progmodes/cc-menus.el b/lisp/progmodes/cc-menus.el index a099ec1de95..52b47a58732 100644 --- a/lisp/progmodes/cc-menus.el +++ b/lisp/progmodes/cc-menus.el @@ -172,7 +172,7 @@ A sample value might look like: `\\(_P\\|_PROTO\\)'.") "[ \t\n\r]*")) (defun cc-imenu-java-build-type-args-regex (depth) - "Builds regexp for type arguments list with DEPTH allowed + "Build regexp for type arguments list with DEPTH allowed nested angle brackets constructs." (if (> depth 0) (concat "<" diff --git a/lisp/progmodes/cc-mode.el b/lisp/progmodes/cc-mode.el index 057d292246f..c818c1a3582 100644 --- a/lisp/progmodes/cc-mode.el +++ b/lisp/progmodes/cc-mode.el @@ -575,9 +575,8 @@ preferably use the `c-mode-menu' language constant directly." (make-variable-buffer-local 'c-max-syn-tab-mkr) (defun c-basic-common-init (mode default-style) - "Do the necessary initialization for the syntax handling routines -and the line breaking/filling code. Intended to be used by other -packages that embed CC Mode. + "Initialize the syntax handling routines 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'. DEFAULT-STYLE tells which indentation style to install. It has the @@ -2568,17 +2567,17 @@ opening \" and the next unescaped end of line." (defvar c-mode-syntax-table (funcall (c-lang-const c-make-mode-syntax-table c)) - "Syntax table used in c-mode buffers.") + "Syntax table used in `c-mode' buffers.") (defvar c-mode-map (let ((map (c-make-inherited-keymap))) map) - "Keymap used in c-mode buffers.") + "Keymap used in `c-mode' buffers.") ;; Add bindings which are only useful for C. (define-key c-mode-map "\C-c\C-e" 'c-macro-expand) -(easy-menu-define c-c-menu c-mode-map "C Mode Commands" +(easy-menu-define c-c-menu c-mode-map "C Mode Commands." (cons "C" (c-lang-const c-mode-menu c))) ;; In XEmacs >= 21.5 modes should add their own entries to @@ -2617,7 +2616,7 @@ opening \" and the next unescaped end of line." "Major mode for editing C code. To submit a problem report, enter `\\[c-submit-bug-report]' from a -c-mode buffer. This automatically sets up a mail buffer with version +`c-mode' buffer. This automatically sets up a mail buffer with version information already added. You just need to add a description of the problem, including a reproducible test case, and send the message. @@ -2701,7 +2700,7 @@ the code is C or C++ and based on that chooses whether to enable (define-key c++-mode-map "<" 'c-electric-lt-gt) (define-key c++-mode-map ">" 'c-electric-lt-gt) -(easy-menu-define c-c++-menu c++-mode-map "C++ Mode Commands" +(easy-menu-define c-c++-menu c++-mode-map "C++ Mode Commands." (cons "C++" (c-lang-const c-mode-menu c++))) ;;;###autoload @@ -2738,16 +2737,16 @@ Key bindings: (defvar objc-mode-syntax-table (funcall (c-lang-const c-make-mode-syntax-table objc)) - "Syntax table used in objc-mode buffers.") + "Syntax table used in `objc-mode' buffers.") (defvar objc-mode-map (let ((map (c-make-inherited-keymap))) map) - "Keymap used in objc-mode buffers.") + "Keymap used in `objc-mode' buffers.") ;; Add bindings which are only useful for Objective-C. (define-key objc-mode-map "\C-c\C-e" 'c-macro-expand) -(easy-menu-define c-objc-menu objc-mode-map "ObjC Mode Commands" +(easy-menu-define c-objc-menu objc-mode-map "ObjC Mode Commands." (cons "ObjC" (c-lang-const c-mode-menu objc))) ;;;###autoload (add-to-list 'auto-mode-alist '("\\.m\\'" . objc-mode)) @@ -2756,7 +2755,7 @@ Key bindings: (define-derived-mode objc-mode prog-mode "ObjC" "Major mode for editing Objective C code. To submit a problem report, enter `\\[c-submit-bug-report]' from an -objc-mode buffer. This automatically sets up a mail buffer with +`objc-mode' buffer. This automatically sets up a mail buffer with version information already added. You just need to add a description of the problem, including a reproducible test case, and send the message. @@ -2785,12 +2784,12 @@ Key bindings: (defvar java-mode-syntax-table (funcall (c-lang-const c-make-mode-syntax-table java)) - "Syntax table used in java-mode buffers.") + "Syntax table used in `java-mode' buffers.") (defvar java-mode-map (let ((map (c-make-inherited-keymap))) map) - "Keymap used in java-mode buffers.") + "Keymap used in `java-mode' buffers.") ;; Add bindings which are only useful for Java. ;; Regexp trying to describe the beginning of a Java top-level @@ -2800,7 +2799,7 @@ Key bindings: (defconst c-Java-defun-prompt-regexp "^[ \t]*\\(\\(\\(public\\|protected\\|private\\|const\\|abstract\\|synchronized\\|final\\|static\\|threadsafe\\|transient\\|native\\|volatile\\)\\s-+\\)*\\(\\(\\([[a-zA-Z][][_$.a-zA-Z0-9]+\\|[[a-zA-Z]\\)\\s-*\\)\\s-+\\)\\)?\\(\\([[a-zA-Z][][_$.a-zA-Z0-9]*\\s-+\\)\\s-*\\)?\\([_a-zA-Z][^][ \t:;.,{}()\^?=]*\\|\\([_$a-zA-Z][_$.a-zA-Z0-9]*\\)\\)\\s-*\\(([^);{}]*)\\)?\\([] \t]*\\)\\(\\s-*\\\\s-*\\(\\([_$a-zA-Z][_$.a-zA-Z0-9]*\\)[, \t\n\r\f\v]*\\)+\\)?\\s-*") -(easy-menu-define c-java-menu java-mode-map "Java Mode Commands" +(easy-menu-define c-java-menu java-mode-map "Java Mode Commands." (cons "Java" (c-lang-const c-mode-menu java))) ;;;###autoload (add-to-list 'auto-mode-alist '("\\.java\\'" . java-mode)) @@ -2809,7 +2808,7 @@ Key bindings: (define-derived-mode java-mode prog-mode "Java" "Major mode for editing Java code. To submit a problem report, enter `\\[c-submit-bug-report]' from a -java-mode buffer. This automatically sets up a mail buffer with +`java-mode' buffer. This automatically sets up a mail buffer with version information already added. You just need to add a description of the problem, including a reproducible test case, and send the message. @@ -2836,15 +2835,15 @@ Key bindings: (defvar idl-mode-syntax-table (funcall (c-lang-const c-make-mode-syntax-table idl)) - "Syntax table used in idl-mode buffers.") + "Syntax table used in `idl-mode' buffers.") (defvar idl-mode-map (let ((map (c-make-inherited-keymap))) map) - "Keymap used in idl-mode buffers.") + "Keymap used in `idl-mode' buffers.") ;; Add bindings which are only useful for IDL. -(easy-menu-define c-idl-menu idl-mode-map "IDL Mode Commands" +(easy-menu-define c-idl-menu idl-mode-map "IDL Mode Commands." (cons "IDL" (c-lang-const c-mode-menu idl))) ;;;###autoload (add-to-list 'auto-mode-alist '("\\.idl\\'" . idl-mode)) @@ -2853,7 +2852,7 @@ Key bindings: (define-derived-mode idl-mode prog-mode "IDL" "Major mode for editing CORBA's IDL, PSDL and CIDL code. To submit a problem report, enter `\\[c-submit-bug-report]' from an -idl-mode buffer. This automatically sets up a mail buffer with +`idl-mode' buffer. This automatically sets up a mail buffer with version information already added. You just need to add a description of the problem, including a reproducible test case, and send the message. @@ -2879,16 +2878,16 @@ Key bindings: (defvar pike-mode-syntax-table (funcall (c-lang-const c-make-mode-syntax-table pike)) - "Syntax table used in pike-mode buffers.") + "Syntax table used in `pike-mode' buffers.") (defvar pike-mode-map (let ((map (c-make-inherited-keymap))) map) - "Keymap used in pike-mode buffers.") + "Keymap used in `pike-mode' buffers.") ;; Additional bindings. (define-key pike-mode-map "\C-c\C-e" 'c-macro-expand) -(easy-menu-define c-pike-menu pike-mode-map "Pike Mode Commands" +(easy-menu-define c-pike-menu pike-mode-map "Pike Mode Commands." (cons "Pike" (c-lang-const c-mode-menu pike))) ;;;###autoload (add-to-list 'auto-mode-alist '("\\.\\(u?lpc\\|pike\\|pmod\\(\\.in\\)?\\)\\'" . pike-mode)) @@ -2898,7 +2897,7 @@ Key bindings: (define-derived-mode pike-mode prog-mode "Pike" "Major mode for editing Pike code. To submit a problem report, enter `\\[c-submit-bug-report]' from a -pike-mode buffer. This automatically sets up a mail buffer with +`pike-mode' buffer. This automatically sets up a mail buffer with version information already added. You just need to add a description of the problem, including a reproducible test case, and send the message. @@ -2932,7 +2931,7 @@ Key bindings: (defvar awk-mode-map (let ((map (c-make-inherited-keymap))) map) - "Keymap used in awk-mode buffers.") + "Keymap used in `awk-mode' buffers.") ;; Add bindings which are only useful for awk. (define-key awk-mode-map "#" 'self-insert-command);Overrides electric parent binding. (define-key awk-mode-map "/" 'self-insert-command);Overrides electric parent binding. @@ -2945,7 +2944,7 @@ Key bindings: (define-key awk-mode-map "\C-\M-a" 'c-awk-beginning-of-defun) (define-key awk-mode-map "\C-\M-e" 'c-awk-end-of-defun) -(easy-menu-define c-awk-menu awk-mode-map "AWK Mode Commands" +(easy-menu-define c-awk-menu awk-mode-map "AWK Mode Commands." (cons "AWK" (c-lang-const c-mode-menu awk))) ;; (require 'cc-awk) brings these in. @@ -2956,7 +2955,7 @@ Key bindings: (define-derived-mode awk-mode prog-mode "AWK" "Major mode for editing AWK code. To submit a problem report, enter `\\[c-submit-bug-report]' from an -awk-mode buffer. This automatically sets up a mail buffer with version +`awk-mode' buffer. This automatically sets up a mail buffer with version information already added. You just need to add a description of the problem, including a reproducible test case, and send the message. diff --git a/lisp/progmodes/cc-styles.el b/lisp/progmodes/cc-styles.el index 8514434e9ac..c6b6be5b399 100644 --- a/lisp/progmodes/cc-styles.el +++ b/lisp/progmodes/cc-styles.el @@ -406,7 +406,7 @@ a null operation." ;;;###autoload (defun c-add-style (style description &optional set-p) - "Adds a style to `c-style-alist', or updates an existing one. + "Add a style to `c-style-alist', or update an existing one. STYLE is a string identifying the style to add or update. DESCRIPTION is an association list describing the style and must be of the form: diff --git a/lisp/progmodes/cc-vars.el b/lisp/progmodes/cc-vars.el index b33fea0b48c..dcd9546d9aa 100644 --- a/lisp/progmodes/cc-vars.el +++ b/lisp/progmodes/cc-vars.el @@ -1427,23 +1427,23 @@ localized, they cannot be made global again. This variable must be set appropriately before CC Mode is loaded. The list of variables to buffer localize are: - c-basic-offset - c-comment-only-line-offset - c-indent-comment-alist - c-indent-comments-syntactically-p - c-block-comment-prefix - c-comment-prefix-regexp - c-doc-comment-style - c-cleanup-list - c-hanging-braces-alist - c-hanging-colons-alist - c-hanging-semi&comma-criteria - c-backslash-column - c-backslash-max-column - c-label-minimum-indentation - c-offsets-alist - c-special-indent-hook - c-indentation-style" + `c-basic-offset' + `c-comment-only-line-offset' + `c-indent-comment-alist' + `c-indent-comments-syntactically-p' + `c-block-comment-prefix' + `c-comment-prefix-regexp' + `c-doc-comment-style' + `c-cleanup-list' + `c-hanging-braces-alist' + `c-hanging-colons-alist' + `c-hanging-semi&comma-criteria' + `c-backslash-column' + `c-backslash-max-column' + `c-label-minimum-indentation' + `c-offsets-alist' + `c-special-indent-hook' + `c-indentation-style'" :type 'boolean :safe 'booleanp :group 'c) @@ -1864,13 +1864,13 @@ Set from `c-comment-prefix-regexp' at mode initialization.") (defvar c-string-par-start ;; (concat "\\(" (default-value 'paragraph-start) "\\)\\|[ \t]*\\\\$") "\f\\|[ \t]*\\\\?$" - "Value of paragraph-start used when scanning strings. + "Value of `paragraph-start' used when scanning strings. It treats escaped EOLs as whitespace.") (defvar c-string-par-separate ;; (concat "\\(" (default-value 'paragraph-separate) "\\)\\|[ \t]*\\\\$") "[ \t\f]*\\\\?$" - "Value of paragraph-separate used when scanning strings. + "Value of `paragraph-separate' used when scanning strings. It treats escaped EOLs as whitespace.") (defvar c-sentence-end-with-esc-eol @@ -1878,7 +1878,7 @@ It treats escaped EOLs as whitespace.") ;; N.B.: "$" would be illegal when not enclosed like "\\($\\)". "\\|" "[.?!][]\"')}]* ?\\\\\\($\\)[ \t\n]*" "\\)") - "Value used like sentence-end used when scanning strings. + "Value used like `sentence-end' used when scanning strings. It treats escaped EOLs as whitespace.") diff --git a/lisp/progmodes/cperl-mode.el b/lisp/progmodes/cperl-mode.el index 1147889969b..634dd29bad6 100644 --- a/lisp/progmodes/cperl-mode.el +++ b/lisp/progmodes/cperl-mode.el @@ -308,7 +308,7 @@ Can be overwritten by `cperl-hairy' if nil." Can be overwritten by `cperl-hairy' if nil. Uses `abbrev-mode' to do the expansion. If you want to use your -own abbrevs in cperl-mode, but do not want keywords to be +own abbrevs in `cperl-mode', but do not want keywords to be electric, you must redefine `cperl-mode-abbrev-table': do \\[edit-abbrevs], search for `cperl-mode-abbrev-table', and, in that paragraph, delete the words that appear at the ends of lines and @@ -1584,7 +1584,7 @@ into \\{cperl-mode-map} -Setting the variable `cperl-font-lock' to t switches on font-lock-mode +Setting the variable `cperl-font-lock' to t switches on `font-lock-mode' \(even with older Emacsen), `cperl-electric-lbrace-space' to t switches on electric space between $ and {, `cperl-electric-parens-string' is the string that contains parentheses that should be electric in CPerl @@ -2577,9 +2577,9 @@ Return the amount the indentation changed by." (not (in ":")))))))) (defun cperl-get-state (&optional parse-start start-state) - "Return list (START STATE DEPTH PRESTART), + "Return list (START STATE DEPTH PRESTART). START is a good place to start parsing, or equal to -PARSE-START if preset, +PARSE-START if preset. STATE is what is returned by `parse-partial-sexp'. DEPTH is true is we are immediately after end of block which contains START. @@ -3110,8 +3110,9 @@ and closing parentheses and brackets." (error "Got strange value of indent: %s" i)))))) (defun cperl-calculate-indent-within-comment () - "Return the indentation amount for line, assuming that -the current line is to be regarded as part of a block comment." + "Return the indentation amount for line. +Assume that the current line is to be regarded as part of a block +comment." (let (end) (save-excursion (beginning-of-line) @@ -8523,7 +8524,7 @@ If a region is highlighted, restricts to the region." beg end)))) (defun cperl-map-pods-heres (func &optional prop s end) - "Executes a function over regions of pods or here-documents. + "Execute a function over regions of pods or here-documents. PROP is the text-property to search for; default to `in-pod'. Stop when function returns nil." (let (pos posend has-prop (cont t)) @@ -8698,7 +8699,7 @@ Delay of auto-help controlled by `cperl-lazy-help-time'." (remove-text-properties beg end '(face nil)))) (defun cperl-font-lock-fontify-region-function (beg end loudly) - "Extends the region to safe positions, then calls the default function. + "Extend the region to safe positions, then call the default function. Newer `font-lock's can do it themselves. We unwind only as far as needed for fontification. Syntaxification may do extra unwind via `cperl-unwind-to-safe'." diff --git a/lisp/progmodes/ebnf-dtd.el b/lisp/progmodes/ebnf-dtd.el index 93bae5a33c5..9185711848c 100644 --- a/lisp/progmodes/ebnf-dtd.el +++ b/lisp/progmodes/ebnf-dtd.el @@ -56,14 +56,14 @@ ;; ;; Char ::= #x9 | #xA | #xD ;; | [#x20-#xD7FF] | [#xE000-#xFFFD] | [#x10000-#x10FFFF] -;; /* any Unicode character, excluding the surrogate blocks, FFFE, and FFFF. */ +;; /* any Unicode character, excluding the surrogate blocks, FFFE, and FFFF. */ ;; ;; /* NOTE: ;; ;; Document authors are encouraged to avoid "compatibility characters", as ;; defined in section 6.8 of [Unicode] (see also D21 in section 3.6 of ;; [Unicode3]). The characters defined in the following ranges are also -;; discouraged. They are either control characters or permanently undefined +;; discouraged. They are either control characters or permanently undefined ;; Unicode characters: ;; ;; [#x7F-#x84], [#x86-#x9F], [#xFDD0-#xFDDF], @@ -72,7 +72,7 @@ ;; [#7FFFE-#x7FFFF], [#8FFFE-#x8FFFF], [#9FFFE-#x9FFFF], ;; [#AFFFE-#xAFFFF], [#BFFFE-#xBFFFF], [#CFFFE-#xCFFFF], ;; [#DFFFE-#xDFFFF], [#EFFFE-#xEFFFF], [#FFFFE-#xFFFFF], -;; [#10FFFE-#x10FFFF]. */ +;; [#10FFFE-#x10FFFF]. */ ;; ;; ;; /* White Space */ @@ -115,7 +115,7 @@ ;; Although the EntityValue production allows the definition of a general ;; entity consisting of a single explicit < in the literal (e.g., ), it is strongly advised to avoid this practice since any -;; reference to that entity will cause a well-formedness error. */ +;; reference to that entity will cause a well-formedness error. */ ;; ;; ;; /* Character Data */ diff --git a/lisp/progmodes/ebnf-ebx.el b/lisp/progmodes/ebnf-ebx.el index 5d8541931e1..ae48881ee9e 100644 --- a/lisp/progmodes/ebnf-ebx.el +++ b/lisp/progmodes/ebnf-ebx.el @@ -43,7 +43,7 @@ ;; ;; ;; rule ::= symbol '::=' expression -;; /* rules are separated by at least one blank line. */ +;; /* rules are separated by at least one blank line. */ ;; ;; expression ::= concatenation ('|' concatenation)* ;; diff --git a/lisp/progmodes/elisp-mode.el b/lisp/progmodes/elisp-mode.el index 55325ef488b..d40ae476a69 100644 --- a/lisp/progmodes/elisp-mode.el +++ b/lisp/progmodes/elisp-mode.el @@ -204,7 +204,7 @@ All commands in `lisp-mode-shared-map' are inherited by this map.") Load the compiled code when finished. Use `emacs-lisp-byte-compile-and-load' in combination with -`native-comp-deferred-compilation' set to `t' to achieve asynchronous +`native-comp-deferred-compilation' set to t to achieve asynchronous native compilation." (interactive nil emacs-lisp-mode) (emacs-lisp--before-compile-buffer) @@ -1249,7 +1249,7 @@ this command arranges for all errors to enter the debugger." (defun last-sexp-setup-props (beg end value alt1 alt2) "Set up text properties for the output of `elisp--eval-last-sexp'. -BEG and END are the start and end of the output in current-buffer. +BEG and END are the start and end of the output in current buffer. VALUE is the Lisp value printed, ALT1 and ALT2 are strings for the alternative printed representations that can be displayed." (let ((map (make-sparse-keymap))) diff --git a/lisp/progmodes/etags.el b/lisp/progmodes/etags.el index cddf3ba0b98..e6af2b12c73 100644 --- a/lisp/progmodes/etags.el +++ b/lisp/progmodes/etags.el @@ -749,7 +749,7 @@ Returns t if it visits a tags table, or nil if there are no more in the list." "Return the file name of the file whose tags point is within. Assumes the tags table is the current buffer. If RELATIVE is non-nil, file name returned is relative to tags -table file's directory. If RELATIVE is nil, file name returned +table file's directory. If RELATIVE is nil, file name returned is complete." (funcall file-of-tag-function relative)) diff --git a/lisp/progmodes/f90.el b/lisp/progmodes/f90.el index 5c0b7880e8b..3f2c9b71485 100644 --- a/lisp/progmodes/f90.el +++ b/lisp/progmodes/f90.el @@ -64,10 +64,11 @@ ;; The function f90-comment-region toggles insertion of ;; the variable f90-comment-region in every line of the region. -;; One common convention for free vs. fixed format is that free format files -;; have the ending .f90 or .f95 while fixed format files have the ending .f. -;; Emacs automatically loads Fortran files in the appropriate mode based -;; on extension. You can modify this by adjusting the variable auto-mode-alist. +;; One common convention for free vs. fixed format is that free format +;; files have the ending .f90 or .f95 while fixed format files have +;; the ending .f. Emacs automatically loads Fortran files in the +;; appropriate mode based on extension. You can modify this by +;; adjusting the variable `auto-mode-alist'. ;; For example: ;; (add-to-list 'auto-mode-alist '("\\.f\\'" . f90-mode)) @@ -104,21 +105,21 @@ ;; (if f90-auto-keyword-case ; change case of all keywords on startup ;; (f90-change-keywords f90-auto-keyword-case)))) ;; -;; in your init file. You can also customize the lists -;; f90-font-lock-keywords, etc. +;; in your init file. You can also customize the lists +;; `f90-font-lock-keywords', etc. ;; ;; The auto-fill and abbreviation minor modes are accessible from the F90 menu, ;; or by using M-x auto-fill-mode and M-x abbrev-mode, respectively. ;; Remarks -;; 1) Line numbers are by default left-justified. If f90-leave-line-no is +;; 1) Line numbers are by default left-justified. If f90-leave-line-no is ;; non-nil, the line numbers are never touched. ;; 2) Multi-; statements like "do i=1,20 ; j=j+i ; end do" are not handled ;; correctly, but I imagine them to be rare. ;; 3) Regexps for hilit19 are no longer supported. ;; 4) For FIXED FORMAT code, use fortran mode. ;; 5) Preprocessor directives, i.e., lines starting with # are left-justified -;; and are untouched by all case-changing commands. There is, at present, no +;; and are untouched by all case-changing commands. There is, at present, no ;; mechanism for treating multi-line directives (continued by \ ). ;; 6) f77 do-loops do 10 i=.. ; ; 10 continue are not correctly indented. ;; You are urged to use f90-do loops (with labels if you wish). @@ -140,7 +141,7 @@ ;; f90-font-lock-1, f90-font-lock-2, f90-font-lock-3, f90-font-lock-4 ;; Original author's thanks -;; Thanks to all the people who have tested the mode. Special thanks to Jens +;; Thanks to all the people who have tested the mode. Special thanks to Jens ;; Bloch Helmers for encouraging me to write this code, for creative ;; suggestions as well as for the lists of hpf-commands. ;; Also thanks to the authors of the fortran and pascal modes, on which some diff --git a/lisp/progmodes/flymake-cc.el b/lisp/progmodes/flymake-cc.el index 907300eb274..3ae3fcb9fec 100644 --- a/lisp/progmodes/flymake-cc.el +++ b/lisp/progmodes/flymake-cc.el @@ -99,7 +99,7 @@ SOURCE." (cond ((derived-mode-p 'c++-mode) "c++") (t "c"))))) -(defvar-local flymake-cc--proc nil "Internal variable for `flymake-cc'") +(defvar-local flymake-cc--proc nil "Internal variable for `flymake-cc'.") ;; forward declare this to shoosh compiler (instead of requiring ;; flymake-proc) diff --git a/lisp/progmodes/flymake-proc.el b/lisp/progmodes/flymake-proc.el index 9cbad121d1f..27b46a45c50 100644 --- a/lisp/progmodes/flymake-proc.el +++ b/lisp/progmodes/flymake-proc.el @@ -188,10 +188,14 @@ Convert it to Flymake internal format." 2 4 5 6)) ;; compilation-error-regexp-alist) (flymake-proc-reformat-err-line-patterns-from-compile-el compilation-error-regexp-alist-alist)) - "Patterns for matching error/warning lines. Each pattern has the form -\(REGEXP FILE-IDX LINE-IDX COL-IDX ERR-TEXT-IDX). -Use `flymake-proc-reformat-err-line-patterns-from-compile-el' to add patterns -from compile.el") + "Patterns for matching error/warning lines. + +Each pattern has the form: + + (REGEXP FILE-IDX LINE-IDX COL-IDX ERR-TEXT-IDX) + +Use `flymake-proc-reformat-err-line-patterns-from-compile-el' to +add patterns from compile.el.") (define-obsolete-variable-alias 'flymake-warning-re 'flymake-proc-diagnostic-type-pred "26.1") (defvar flymake-proc-diagnostic-type-pred @@ -760,7 +764,7 @@ May only be called in a dynamic environment where (defun flymake-proc-legacy-flymake (report-fn &rest args) "Flymake backend based on the original Flymake implementation. This function is suitable for inclusion in -`flymake-diagnostic-functions'. For backward compatibility, it +`flymake-diagnostic-functions'. For backward compatibility, it can also be executed interactively independently of `flymake-mode'." ;; Interactively, behave as if flymake had invoked us through its diff --git a/lisp/progmodes/flymake.el b/lisp/progmodes/flymake.el index fb612eebc77..e8ce0e723e4 100644 --- a/lisp/progmodes/flymake.el +++ b/lisp/progmodes/flymake.el @@ -1747,7 +1747,7 @@ some of this variable's contents the diagnostic listings.") (revert-buffer)))) (defun flymake--update-diagnostics-listings (buffer) - "Update diagnostics listings somehow relevant to BUFFER" + "Update diagnostics listings somehow relevant to BUFFER." (dolist (probe (buffer-list)) (with-current-buffer probe (when (or (and (eq major-mode 'flymake-project-diagnostics-mode) diff --git a/lisp/progmodes/fortran.el b/lisp/progmodes/fortran.el index 707226fb2a5..7cf4ce27305 100644 --- a/lisp/progmodes/fortran.el +++ b/lisp/progmodes/fortran.el @@ -749,7 +749,7 @@ Variables controlling indentation style and extra features: `fortran-comment-line-extra-indent' Amount of extra indentation for text in full-line comments (default 0). `fortran-comment-indent-style' - How to indent the text in full-line comments. Allowed values are: + How to indent the text in full-line comments. Allowed values are: nil don't change the indentation `fixed' indent to `fortran-comment-line-extra-indent' beyond the value of either diff --git a/lisp/progmodes/gdb-mi.el b/lisp/progmodes/gdb-mi.el index 41384e129b0..902466e4feb 100644 --- a/lisp/progmodes/gdb-mi.el +++ b/lisp/progmodes/gdb-mi.el @@ -788,7 +788,7 @@ becomes the initial working directory and source-file directory for your debugger. If COMMAND-LINE requests that gdb attaches to a process PID, gdb will run in *gud-PID*, otherwise it will run in *gud*; in these -cases the initial working directory is the default-directory of +cases the initial working directory is the `default-directory' of the buffer in which this command was invoked. COMMAND-LINE should include \"-i=mi\" to use gdb's MI text interface. diff --git a/lisp/progmodes/grep.el b/lisp/progmodes/grep.el index b2a9b3e3206..d7f4582dd0b 100644 --- a/lisp/progmodes/grep.el +++ b/lisp/progmodes/grep.el @@ -523,7 +523,7 @@ This variable's value takes effect when `grep-compute-defaults' is called." ;;;###autoload (defvar grep-history nil "History list for grep.") ;;;###autoload -(defvar grep-find-history nil "History list for grep-find.") +(defvar grep-find-history nil "History list for `grep-find'.") ;; History of lgrep and rgrep regexp and files args. (defvar grep-regexp-history nil) diff --git a/lisp/progmodes/gud.el b/lisp/progmodes/gud.el index d8c77f7f231..2061d414802 100644 --- a/lisp/progmodes/gud.el +++ b/lisp/progmodes/gud.el @@ -31,7 +31,7 @@ ;; added support for xdb (HPUX debugger). Rick Sladkey ;; wrote the GDB command completion code. Dave Love ;; added the IRIX kluge, re-implemented the Mips-ish variant -;; and added a menu. Brian D. Carlstrom combined the IRIX +;; and added a menu. Brian D. Carlstrom combined the IRIX ;; kluge with the gud-xdb-directories hack producing gud-dbx-directories. ;; Derek L. Davies added support for jdb (Java ;; debugger.) Jan Nieuwenhuizen added support for the Guile REPL (Guile @@ -795,7 +795,7 @@ becomes the initial working directory and source-file directory for your debugger. If COMMAND-LINE requests that gdb attaches to a process PID, gdb will run in *gud-PID*, otherwise it will run in *gud*; in these -cases the initial working directory is the default-directory of +cases the initial working directory is the `default-directory' of the buffer in which this command was invoked." (interactive (list (gud-query-cmdline 'gud-gdb))) @@ -2677,8 +2677,8 @@ gud, see `gud-mode'." (define-derived-mode gud-mode comint-mode "Debugger" "Major mode for interacting with an inferior debugger process. - You start it up with one of the commands M-x gdb, M-x sdb, M-x dbx, -M-x perldb, M-x xdb, or M-x jdb. Each entry point finishes by executing a + You start it up with one of the commands \\[gdb], \\[sdb], \\[dbx], +\\[perldb], \\[xdb], or \\[jdb]. Each entry point finishes by executing a hook; `gdb-mode-hook', `sdb-mode-hook', `dbx-mode-hook', `perldb-mode-hook', `xdb-mode-hook', or `jdb-mode-hook' respectively. @@ -3333,7 +3333,7 @@ This function uses the `gud-jdb-classpath' (and optional `gud-jdb-sourcepath') list(s) to derive a file pathname relative to its classpath directory. The values in `gud-jdb-classpath' are assumed to have been converted to absolute -pathname standards using file-truename. +pathname standards using `file-truename'. If F is visited by a buffer and its mode is CC-mode(Java), syntactic information of LINE is used to find the enclosing (nested) class string which is appended to the top level diff --git a/lisp/progmodes/hideif.el b/lisp/progmodes/hideif.el index 7cd49a69d4a..a18a67249ae 100644 --- a/lisp/progmodes/hideif.el +++ b/lisp/progmodes/hideif.el @@ -1071,7 +1071,7 @@ Assuming we've just performed a `hif-token-regexp' lookup." (error "`defined' followed by non-identifier: %S" target)) (if (and paren (not (eq (hif-nexttoken) 'hif-rparen))) - (error "missing right parenthesis for `defined'")) + (error "Missing right parenthesis for `defined'")) (setq hif-token (list 'hif-defined 'hif-lparen target 'hif-rparen))) (push hif-token tokens)) diff --git a/lisp/progmodes/idlw-complete-structtag.el b/lisp/progmodes/idlw-complete-structtag.el index 6d2d402e358..bf49c92552a 100644 --- a/lisp/progmodes/idlw-complete-structtag.el +++ b/lisp/progmodes/idlw-complete-structtag.el @@ -44,7 +44,7 @@ ;; completion for its tags. ;; ;; This file is a completion plugin which implements this kind of -;; completion. It is also an example which shows how completion plugins +;; completion. It is also an example which shows how completion plugins ;; should be programmed. ;; ;; New versions of IDLWAVE, documentation, and more information available @@ -86,6 +86,8 @@ ;; - You can force an update of the tag list with the usual command ;; to update routine info in IDLWAVE: C-c C-i +;;; Code: + (require 'idlwave) (declare-function idlwave-shell-buffer "idlw-shell") diff --git a/lisp/progmodes/idlw-help.el b/lisp/progmodes/idlw-help.el index b90bbedd453..ffa3d78b4d2 100644 --- a/lisp/progmodes/idlw-help.el +++ b/lisp/progmodes/idlw-help.el @@ -218,9 +218,8 @@ support." ;; Define the menu for the Help application -(easy-menu-define - idlwave-help-menu idlwave-help-mode-map - "Menu for Help IDLWAVE system" +(easy-menu-define idlwave-help-menu idlwave-help-mode-map + "Menu for Help IDLWAVE system." '("IDLHelp" ["Definition <-> Help Text" idlwave-help-toggle-header-match-and-def t] ["Find DocLib Header" idlwave-help-find-header t] diff --git a/lisp/progmodes/idlw-shell.el b/lisp/progmodes/idlw-shell.el index f2bfbf3e379..fc3d603f066 100644 --- a/lisp/progmodes/idlw-shell.el +++ b/lisp/progmodes/idlw-shell.el @@ -124,7 +124,7 @@ process output is made by surrounding this name with `*'s." (defcustom idlwave-shell-frame-parameters '((height . 30) (unsplittable . nil)) - "The frame parameters for a dedicated idlwave-shell frame. + "The frame parameters for a dedicated `idlwave-shell' frame. See also `idlwave-shell-use-dedicated-frame'. The default makes the frame splittable, so that completion works correctly." :group 'idlwave-shell-general-setup @@ -154,10 +154,10 @@ t Arrows force the cursor back to the current command line and (defcustom idlwave-shell-use-toolbar t "Non-nil means, use the debugging toolbar in all IDL related buffers. -Starting the shell will then add the toolbar to all idlwave-mode buffers. +Starting the shell will then add the toolbar to all `idlwave-mode' buffers. Exiting the shell will removed everywhere. At any time you can toggle the display of the toolbar with -`C-c C-d C-t' (`idlwave-shell-toggle-toolbar')." +\\[idlwave-shell-toggle-toolbar]." :group 'idlwave-shell-general-setup :type 'boolean) @@ -550,7 +550,7 @@ the expression output by IDL." ;; Other variables (defvar idlwave-shell-temp-pro-file nil - "Absolute pathname for temporary IDL file for compiling regions") + "Absolute pathname for temporary IDL file for compiling regions.") (defvar idlwave-shell-temp-rinfo-save-file nil "Absolute pathname for temporary IDL file save file for routine_info. @@ -590,7 +590,7 @@ the directory stack.") "Additional info displayed in the mode line.") (defvar idlwave-shell-default-directory nil - "The default directory in the idlwave-shell buffer, of outside use.") + "The default directory in the `idlwave-shell' buffer, of outside use.") (defvar idlwave-shell-last-save-and-action-file nil "The last file which was compiled with `idlwave-shell-save-and-...'.") @@ -734,9 +734,9 @@ IDL is currently stopped.") (defconst idlwave-shell-trace-message-re "^% At " ;; First line of a trace message - "A regular expression matching IDL trace messages. These are the -messages containing file and line information of a current -traceback.") + "A regular expression matching IDL trace messages. +These are the messages containing file and line information of a +current traceback.") (defconst idlwave-shell-step-messages '("^% Stepped to:" @@ -1384,14 +1384,14 @@ Otherwise just move the line. Move down unless UP is non-nil." (forward-line (- arg))))) (defun idlwave-shell-up-or-history (&optional arg) -"When in last line of process buffer, move to previous input. - Otherwise just go up one line." + "When in last line of process buffer, move to previous input. +Otherwise just go up one line." (interactive "p") (idlwave-shell-move-or-history t arg)) (defun idlwave-shell-down-or-history (&optional arg) -"When in last line of process buffer, move to next input. - Otherwise just go down one line." + "When in last line of process buffer, move to next input. +Otherwise just go down one line." (interactive "p") (idlwave-shell-move-or-history nil arg)) @@ -1897,7 +1897,7 @@ HEAP_GC, /VERBOSE" (cons sysdir (nreverse dirs)))) (defun idlwave-shell-routine-info-filter () - "Function which parses the special output from idlwave_routine_info.pro." + "Parse the special output from idlwave_routine_info.pro." (let ((text idlwave-shell-command-output) (start 0) sep sep-re file type spec specs name cs key keys class entry) @@ -2056,7 +2056,7 @@ Change the default directory for the process buffer to concur." (idlwave-new-sintern-type execcomm) (defun idlwave-shell-complete (&optional arg) - "Do completion in the idlwave-shell buffer. + "Do completion in the `idlwave-shell' buffer. Calls `idlwave-shell-complete-filename' after some executive commands or in strings. Otherwise, calls `idlwave-complete' to complete modules and keywords." @@ -2136,7 +2136,7 @@ args of an executive .run, .rnew or .compile." (and (memq (preceding-char) '(?\' ?\")) t)))) (defun idlwave-shell-batch-command () - "Return t if we're in a batch command statement like @foo" + "Return t if we're in a batch command statement like \"@foo\"." (let ((limit (point-at-bol))) (save-excursion ;; Skip backwards over filename @@ -2145,7 +2145,7 @@ args of an executive .run, .rnew or .compile." (and (eq (preceding-char) ?@) (not (idlwave-in-quote)))))) (defun idlwave-shell-shell-command () - "Return t if we're in a shell command statement like $ls" + "Return t if we're in a shell command statement like \"$ls\"." (save-excursion (idlwave-beginning-of-statement) (looking-at "\\$"))) @@ -2276,7 +2276,7 @@ matter what the settings of that variable." (if (not (idlwave-shell-valid-frame frame)) ;; fixme: errors are dangerous in shell filters. but i think i ;; have never encountered this one. - (error "invalid frame - unable to access file: %s" (car frame)) + (error "Invalid frame - unable to access file: %s" (car frame)) ;; ;; buffer : the buffer to display a line in. ;; select-shell: current buffer is the shell. @@ -3147,14 +3147,14 @@ index - the index number of the breakpoint internal to IDL. module - the module for breakpoint internal to IDL. Remaining elements of the cdr: -data - Data associated with the breakpoint by idlwave-shell currently +data - Data associated with the breakpoint by `idlwave-shell' currently contains four items: count - number of times to execute breakpoint. When count reaches 0 the breakpoint is cleared and removed from the alist. command - command to execute when breakpoint is reached, either a - lisp function to be called with `funcall' with no arguments or a + Lisp function to be called with `funcall' with no arguments or a list to be evaluated with `eval'. condition - any condition to apply to the breakpoint. @@ -4316,11 +4316,11 @@ Shell debugging commands are available as single key sequences." ["Toggle Toolbar" idlwave-shell-toggle-toolbar t] ["Exit IDL" idlwave-shell-quit t])) -(easy-menu-define - idlwave-mode-debug-menu idlwave-mode-map "IDL debugging menus" +(easy-menu-define idlwave-mode-debug-menu idlwave-mode-map + "IDL debugging menus." idlwave-shell-menu-def) -(easy-menu-define - idlwave-shell-mode-menu idlwave-shell-mode-map "IDL shell menus" +(easy-menu-define idlwave-shell-mode-menu idlwave-shell-mode-map + "IDL shell menus." idlwave-shell-menu-def) ;; The Breakpoint Glyph ------------------------------------------------------- diff --git a/lisp/progmodes/idlw-toolbar.el b/lisp/progmodes/idlw-toolbar.el index d3f47fcf45e..c3ffcd18ced 100644 --- a/lisp/progmodes/idlw-toolbar.el +++ b/lisp/progmodes/idlw-toolbar.el @@ -355,7 +355,7 @@ static char * file[] = { \" \", \" \", \" \"};") - "The edit-cmd icon") + "The edit-cmd icon.") (defvar idlwave-toolbar-run-icon (idlwave-toolbar-make-button diff --git a/lisp/progmodes/idlwave.el b/lisp/progmodes/idlwave.el index 91be4016232..ce984d32b53 100644 --- a/lisp/progmodes/idlwave.el +++ b/lisp/progmodes/idlwave.el @@ -119,7 +119,7 @@ ;; ;; Moving the point backwards in conjunction with abbrev expansion ;; does not work as I would like it, but this is a problem with -;; emacs abbrev expansion done by the self-insert-command. It ends +;; Emacs abbrev expansion done by the self-insert-command. It ends ;; up inserting the character that expanded the abbrev after moving ;; point backward, e.g., "\cl" expanded with a space becomes ;; "LONG( )" with point before the close paren. This is solved by @@ -1359,7 +1359,7 @@ Normally a space.") (defconst idlwave-continuation-char ?$ "Character which is inserted as a last character on previous line by - \\[idlwave-split-line] to begin a continuation line. Normally $.") +\\[idlwave-split-line] to begin a continuation line. Normally $.") (defconst idlwave-mode-version "6.1_em22") @@ -1953,7 +1953,7 @@ The main features of this mode are (defvar idlwave--command-function nil "If non-nil, a function called from `post-command-hook'. -It is evaluated in the lisp function `idlwave-command-hook' which is +It is evaluated in the Lisp function `idlwave-command-hook' which is placed in `post-command-hook'.") (defun idlwave-command-hook () @@ -4067,7 +4067,7 @@ blank lines." iname)) (defun idlwave-sintern-keyword-list (kwd-list &optional set) - "Sintern a set of keywords (file (key . link) (key2 . link2) ...)" + "Sintern a set of keywords (file (key . link) (key2 . link2) ...)." (mapc (lambda(x) (setcar x (idlwave-sintern-keyword (car x) set))) (cdr kwd-list)) @@ -5049,7 +5049,7 @@ Can run from `after-save-hook'." ;;----- Scanning buffers ------------------- (defun idlwave-get-routine-info-from-buffers (buffers) - "Call `idlwave-get-buffer-routine-info' on idlwave-mode buffers in BUFFERS." + "Call `idlwave-get-buffer-routine-info' on `idlwave-mode' buffers in BUFFERS." (let (buf routine-lists res) (save-excursion (while (setq buf (pop buffers)) @@ -8971,10 +8971,10 @@ Assumes that point is at the beginning of the unit as found by idlwave-shell-automatic-start)])) (easy-menu-define idlwave-mode-menu idlwave-mode-map - "IDL and WAVE CL editing menu" + "IDL and WAVE CL editing menu." idlwave-mode-menu-def) (easy-menu-define idlwave-mode-debug-menu idlwave-mode-map - "IDL and WAVE CL editing menu" + "IDL and WAVE CL editing menu." idlwave-mode-debug-menu-def) (defun idlwave-customize () diff --git a/lisp/progmodes/js.el b/lisp/progmodes/js.el index c2481f6095a..845ca8609d7 100644 --- a/lisp/progmodes/js.el +++ b/lisp/progmodes/js.el @@ -24,9 +24,9 @@ ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs. If not, see . -;;; Commentary +;;; Commentary: -;; This is based on Karl Landstrom's barebones javascript-mode. This +;; This is based on Karl Landstrom's barebones javascript-mode. This ;; is much more robust and works with cc-mode's comment filling ;; (mostly). ;; @@ -237,8 +237,7 @@ will create multiple top-level entries. Don't use :prototype unnecessarily: it has an associated cost in performance. If :strip-prototype is present and non-nil, then if the class -name as matched contains -") +name as matched contains.") (defconst js--available-frameworks (cl-loop for style in js--class-styles @@ -554,8 +553,7 @@ If the previous expression also contains a \".\" at the same level, then the \".\"s will be lined up: let x = svg.mumble() - .chained; -" + .chained;" :version "26.1" :type 'boolean :safe 'booleanp) @@ -574,8 +572,8 @@ to `js-jsx-regexps', which see." This enables proper font-locking and indentation of code using Facebook’s “JSX” syntax extension for JavaScript, for use with -Facebook’s “React” library. Font-locking is like sgml-mode. -Indentation is also like sgml-mode, although some indentation +Facebook’s “React” library. Font-locking is like `sgml-mode'. +Indentation is also like `sgml-mode', although some indentation behavior may differ slightly to align more closely with the conventions of the React developer community. @@ -3267,7 +3265,7 @@ the broken-down class name of the item to insert." (defun js--get-all-known-symbols () "Return a hash table of all JavaScript symbols. -This searches all existing `js-mode' buffers. Each key is the +This searches all existing `js-mode' buffers. Each key is the name of a symbol (possibly disambiguated with , where N > 1), and each value is a marker giving the location of that symbol." (cl-loop with symbols = (make-hash-table :test 'equal) diff --git a/lisp/progmodes/ld-script.el b/lisp/progmodes/ld-script.el index 485e64e2492..879eb720651 100644 --- a/lisp/progmodes/ld-script.el +++ b/lisp/progmodes/ld-script.el @@ -167,11 +167,11 @@ ("\\W\\(\\.\\)\\W" 1 ld-script-location-counter-face) ) cpp-font-lock-keywords) - "Default font-lock-keywords for `ld-script-mode'.") + "Default `font-lock-keywords' for `ld-script-mode'.") ;;;###autoload (define-derived-mode ld-script-mode prog-mode "LD-Script" - "A major mode to edit GNU ld script files" + "A major mode to edit GNU ld script files." (setq-local comment-start "/* ") (setq-local comment-end " */") (setq-local font-lock-defaults '(ld-script-font-lock-keywords nil))) diff --git a/lisp/progmodes/octave.el b/lisp/progmodes/octave.el index b1a5f301587..6bf070cf9e5 100644 --- a/lisp/progmodes/octave.el +++ b/lisp/progmodes/octave.el @@ -351,7 +351,7 @@ Non-nil means always go to the next Octave code line after sending." ;; corresponding continuation lines). (defun octave-smie--funcall-p () - "Return non-nil if we're in an expression context. Moves point." + "Return non-nil if we're in an expression context. Move point." (looking-at "[ \t]*(")) (defun octave-smie--end-index-p () @@ -1034,7 +1034,7 @@ directory and makes this the current buffer's default directory." (nth 8 (syntax-ppss))) (defun octave-looking-at-kw (regexp) - "Like `looking-at', but sets `case-fold-search' nil." + "Like `looking-at', but set `case-fold-search' nil first." (let ((case-fold-search nil)) (looking-at regexp))) diff --git a/lisp/progmodes/opascal.el b/lisp/progmodes/opascal.el index 662d2b4b74f..51c888d25f3 100644 --- a/lisp/progmodes/opascal.el +++ b/lisp/progmodes/opascal.el @@ -24,9 +24,10 @@ ;;; Commentary: -;; To enter OPascal mode when you find an Object Pascal source file, one must -;; override the auto-mode-alist to associate OPascal with .pas (and .dpr and -;; .dpk) files. Emacs, by default, will otherwise enter Pascal mode. E.g. +;; To enter OPascal mode when you find an Object Pascal source file, +;; one must override the auto-mode-alist to associate OPascal with +;; .pas (and .dpr and .dpk) files. Emacs, by default, will otherwise +;; enter Pascal mode. For example: ;; ;; (autoload 'opascal-mode "opascal") ;; (add-to-list 'auto-mode-alist @@ -244,8 +245,8 @@ are followed by an expression.") (defconst opascal-begin-previous-tokens `(,@opascal-decl-sections ,@opascal-routine-statements) - "Tokens that a begin token aligns with, but only if not part of a nested -routine.") + "Tokens that a begin token aligns with, but only if not part of a \ +nested routine.") (defconst opascal-space-chars "\000-\011\013- ") ; all except \n (defconst opascal-non-space-chars (concat "^" opascal-space-chars)) @@ -1530,7 +1531,7 @@ If no extension is specified, .pas is assumed. Creates a buffer for the unit." (concat unit ".pas"))) (file (opascal-find-unit-file unit-file))) (if (null file) - (error "unit not found: %s" unit-file) + (error "Unit not found: %s" unit-file) (find-file file) (if (not (derived-mode-p 'opascal-mode)) (opascal-mode))) diff --git a/lisp/progmodes/perl-mode.el b/lisp/progmodes/perl-mode.el index 4e14c30bc5d..20834dd2e1e 100644 --- a/lisp/progmodes/perl-mode.el +++ b/lisp/progmodes/perl-mode.el @@ -101,7 +101,7 @@ :version "28.1") (defvar perl-mode-abbrev-table nil - "Abbrev table in use in perl-mode buffers.") + "Abbrev table in use in `perl-mode' buffers.") (define-abbrev-table 'perl-mode-abbrev-table ()) (defvar perl-mode-map @@ -509,7 +509,7 @@ (defface perl-heredoc '((t (:inherit font-lock-string-face))) - "The face for here-documents. Inherits from font-lock-string-face.") + "The face for here-documents. Inherits from `font-lock-string-face'.") (defun perl-font-lock-syntactic-face-function (state) (cond @@ -644,10 +644,10 @@ the Perl source to be checked as its standard input." ;;;###autoload (defun perl-flymake (report-fn &rest _args) - "Perl backend for Flymake. Launches -`perl-flymake-command' (which see) and passes to its standard -input the contents of the current buffer. The output of this -command is analyzed for error and warning messages." + "Perl backend for Flymake. +Launch `perl-flymake-command' (which see) and pass to its +standard input the contents of the current buffer. The output of +this command is analyzed for error and warning messages." (unless (executable-find (car perl-flymake-command)) (error "Cannot find a suitable checker")) diff --git a/lisp/progmodes/prolog.el b/lisp/progmodes/prolog.el index 2e23c2e2cab..33ca01cc754 100644 --- a/lisp/progmodes/prolog.el +++ b/lisp/progmodes/prolog.el @@ -1272,7 +1272,7 @@ using the commands `send-region', `send-string' and \\[prolog-consult-region]. Commands: Tab indents for Prolog; with argument, shifts rest of expression rigidly with the current line. -Paragraphs are separated only by blank lines and `%%'. `%'s start comments. +Paragraphs are separated only by blank lines and `%%'. `%'s start comments. Return at end of buffer sends line as input. Return not at end copies rest of line to end and sends it. @@ -1352,7 +1352,7 @@ the variable `prolog-prompt-regexp'." (let ((pname (prolog-program-name)) (pswitches (prolog-program-switches))) (if (null pname) - (error "This Prolog system has defined no interpreter.")) + (error "This Prolog system has defined no interpreter")) (unless (comint-check-proc "*prolog*") (with-current-buffer (get-buffer-create "*prolog*") (prolog-inferior-mode) @@ -1641,7 +1641,7 @@ region. This function must be called from the source code buffer." (if prolog-process-flag - (error "Another Prolog task is running.")) + (error "Another Prolog task is running")) (prolog-ensure-process t) (let* ((buffer (get-buffer-create prolog-compilation-buffer)) (real-file buffer-file-name) @@ -2355,7 +2355,7 @@ In effect it sets the `fill-prefix' when inside comments and then calls ) (if prolog-help-function-i (funcall prolog-help-function-i predicate) - (error "Sorry, no help method defined for this Prolog system.")))) + (error "Sorry, no help method defined for this Prolog system")))) )) @@ -2369,7 +2369,7 @@ In effect it sets the `fill-prefix' when inside comments and then calls (pop-to-buffer nil) (Info-goto-node prolog-info-predicate-index) (if (not (re-search-forward str nil t)) - (error "Help on predicate `%s' not found." predicate)) + (error "Help on predicate `%s' not found" predicate)) (setq oldp (point)) (if (re-search-forward str nil t) @@ -2413,7 +2413,7 @@ This function is only available when `prolog-system' is set to `swi'." (process-send-string "prolog" (concat "apropos(" string ").\n")) (display-buffer "*prolog*")) (t - (error "Sorry, no Prolog apropos available for this Prolog system.")))) + (error "Sorry, no Prolog apropos available for this Prolog system")))) (defun prolog-atom-under-point () "Return the atom under or left to the point." @@ -3289,7 +3289,7 @@ PREFIX is the prefix of the search regexp." (easy-menu-define prolog-edit-menu-runtime prolog-mode-map - "Runtime Prolog commands available from the editing buffer" + "Runtime Prolog commands available from the editing buffer." ;; FIXME: Don't use a whole menu for just "Run Mercury". --Stef `("System" ;; Runtime menu name. diff --git a/lisp/progmodes/ps-mode.el b/lisp/progmodes/ps-mode.el index 67c034d0905..68c3cd91fa4 100644 --- a/lisp/progmodes/ps-mode.el +++ b/lisp/progmodes/ps-mode.el @@ -446,7 +446,7 @@ If nil, use `temporary-file-directory'." ps-mode-submit-bug-report t])) -(easy-menu-define ps-mode-main ps-mode-map "PostScript" ps-mode-menu-main) +(easy-menu-define ps-mode-main ps-mode-map "PostScript Menu." ps-mode-menu-main) diff --git a/lisp/progmodes/python.el b/lisp/progmodes/python.el index 19b79b69197..f848f4c1030 100644 --- a/lisp/progmodes/python.el +++ b/lisp/progmodes/python.el @@ -542,7 +542,7 @@ the {...} holes that appear within f-strings." (1 font-lock-function-name-face)) (,(rx symbol-start "class" (1+ space) (group (1+ (or word ?_)))) (1 font-lock-type-face))) - "Font lock keywords to use in python-mode for level 1 decoration. + "Font lock keywords to use in `python-mode' for level 1 decoration. This is the minimum decoration level, including function and class declarations.") @@ -596,7 +596,7 @@ class declarations.") ;; Extras: "__all__") symbol-end) . font-lock-builtin-face)) - "Font lock keywords to use in python-mode for level 2 decoration. + "Font lock keywords to use in `python-mode' for level 2 decoration. This is the medium decoration level, including everything in `python-font-lock-keywords-level-1', as well as keywords and @@ -712,7 +712,7 @@ avoid '==' being treated as an assignment." (or ")" "]") (* space) assignment-operator)) (1 font-lock-variable-name-face))) - "Font lock keywords to use in python-mode for maximum decoration. + "Font lock keywords to use in `python-mode' for maximum decoration. This decoration level includes everything in `python-font-lock-keywords-level-2', as well as constants, @@ -726,7 +726,7 @@ decorators, exceptions, and assignments.") ; is more than 1, or t (which it is, ; by default). ) - "List of font lock keyword specifications to use in python-mode. + "List of font lock keyword specifications to use in `python-mode'. Which one will be chosen depends on the value of `font-lock-maximum-decoration'.") @@ -3072,13 +3072,12 @@ of `error' with a user-friendly message." (or (python-shell-get-process) (if interactivep (user-error - "Start a Python process first with `M-x run-python' or `%s'." + "Start a Python process first with `M-x run-python' or `%s'" ;; Get the binding. (key-description (where-is-internal #'run-python overriding-local-map t))) - (error - "No inferior Python process running.")))) + (error "No inferior Python process running")))) (defun python-shell-get-or-create-process (&optional cmd dedicated show) "Get or create an inferior Python process for current buffer and return it. @@ -4714,10 +4713,10 @@ returns will be used. If not FORCE-PROCESS is passed what docstring))))) (defvar-local python-eldoc-get-doc t - "Non-nil means eldoc should fetch the documentation - automatically. Set to nil by `python-eldoc-function' if - `python-eldoc-function-timeout-permanent' is non-nil and - `python-eldoc-function' times out.") + "Non-nil means eldoc should fetch the documentation automatically. +Set to nil by `python-eldoc-function' if +`python-eldoc-function-timeout-permanent' is non-nil and +`python-eldoc-function' times out.") (defcustom python-eldoc-function-timeout 1 "Timeout for `python-eldoc-function' in seconds." diff --git a/lisp/progmodes/ruby-mode.el b/lisp/progmodes/ruby-mode.el index 6a03856eafc..b0b055bd361 100644 --- a/lisp/progmodes/ruby-mode.el +++ b/lisp/progmodes/ruby-mode.el @@ -151,10 +151,8 @@ This should only be called after matching against `ruby-here-doc-beg-re'." map) "Keymap used in Ruby mode.") -(easy-menu-define - ruby-mode-menu - ruby-mode-map - "Ruby Mode Menu" +(easy-menu-define ruby-mode-menu ruby-mode-map + "Ruby Mode Menu." '("Ruby" ["Beginning of Block" ruby-beginning-of-block t] ["End of Block" ruby-end-of-block t] @@ -936,7 +934,7 @@ Can be one of `heredoc', `modifier', `expr-qstr', `expr-re'." (defun ruby-forward-string (term &optional end no-error expand) "Move forward across one balanced pair of string delimiters. -Skips escaped delimiters. If EXPAND is non-nil, also ignores +Skips escaped delimiters. If EXPAND is non-nil, also ignores delimiters in interpolated strings. TERM should be a string containing either a single, self-matching diff --git a/lisp/progmodes/sql.el b/lisp/progmodes/sql.el index d144d68b571..02eccb33012 100644 --- a/lisp/progmodes/sql.el +++ b/lisp/progmodes/sql.el @@ -2794,7 +2794,7 @@ See `sql-product-alist' for a list of products and supported features." (symbolp v)) (symbol-value v) v)) - (error "`%s' is not a known product; use `sql-add-product' to add it first." product) + (error "`%s' is not a known product; use `sql-add-product' to add it first" product) nil))) (defun sql-product-font-lock (keywords-only imenu) @@ -2952,7 +2952,7 @@ adds a fontification pattern to fontify identifiers ending in "Display a SQLi buffer based on `sql-display-sqli-buffer-function'. If BUF is hidden or `sql-display-sqli-buffer-function' is nil, -then the buffer will not be displayed. Otherwise the BUF is +then the buffer will not be displayed. Otherwise the BUF is displayed." (unless (sql-buffer-hidden-p buf) (cond diff --git a/lisp/progmodes/tcl.el b/lisp/progmodes/tcl.el index f6a50bf1a88..b6a7a20d87f 100644 --- a/lisp/progmodes/tcl.el +++ b/lisp/progmodes/tcl.el @@ -288,7 +288,7 @@ quoted for Tcl." ["Tcl help" tcl-help-on-word tcl-help-directory-list])) (defvar inferior-tcl-buffer nil - "The current inferior-tcl process buffer. + "The current `inferior-tcl' process buffer. MULTIPLE PROCESS SUPPORT =========================================================================== diff --git a/lisp/progmodes/verilog-mode.el b/lisp/progmodes/verilog-mode.el index 2b5f85df2f9..ef2c21da456 100644 --- a/lisp/progmodes/verilog-mode.el +++ b/lisp/progmodes/verilog-mode.el @@ -829,7 +829,7 @@ The name of the function or case will be set between the braces." (defcustom verilog-auto-ignore-concat nil "Non-nil means ignore signals in {...} concatenations for AUTOWIRE etc. This will exclude signals referenced as pin connections in {...} -or (...) from AUTOWIRE, AUTOOUTPUT and friends. See also AUTONOHOOKUP." +or (...) from AUTOWIRE, AUTOOUTPUT and friends. See also AUTONOHOOKUP." :group 'verilog-mode-actions :type 'boolean) (put 'verilog-auto-ignore-concat 'safe-local-variable #'verilog-booleanp) @@ -1529,8 +1529,8 @@ If set will become buffer local.") "Keymap used in Verilog mode.") ;; menus -(easy-menu-define - verilog-menu verilog-mode-map "Menu for Verilog mode" +(easy-menu-define verilog-menu verilog-mode-map + "Menu for Verilog mode." (verilog-easy-menu-filter `("Verilog" ("Choose Compilation Action" @@ -3610,19 +3610,19 @@ inserted using a single call to `verilog-insert'." (search-forward ";" nil t)) (defun verilog-single-declaration-end (limit) - "Returns pos where current (single) declaration statement ends. + "Return pos where current (single) declaration statement ends. Also, this function moves POINT forward to the start of a variable name (skipping the range-part and whitespace). Function expected to be called with POINT just after a declaration keyword. -LIMIT sets the max POINT for searching and moving to. No such limit if LIMIT +LIMIT sets the max POINT for searching and moving to. No such limit if LIMIT is 0. Meaning of *single* declaration: - Eg. In a module's port-list - + E.g. In a module's port-list - module test(input clk, rst, x, output [1:0] y); Here 'input clk, rst, x' is 1 *single* declaration statement, and 'output [1:0] y' is the other single declaration. In the 1st single -declaration, POINT is moved to start of 'clk'. And in the 2nd declaration, +declaration, POINT is moved to start of 'clk'. And in the 2nd declaration, POINT is moved to 'y'." @@ -13651,7 +13651,7 @@ signals to deasserted. the same input/output list as another module, but no internals. Specifically, it finds all outputs in the module, and if that input is not otherwise declared as a register or wire, nor comes -from a AUTOINST submodule's output, creates a tieoff. AUTOTIEOFF +from a AUTOINST submodule's output, creates a tieoff. AUTOTIEOFF does not examine assignments to determine what is already driven. AUTORESET ties signals to deasserted, which is presumed to be zero. @@ -14428,7 +14428,7 @@ See also `verilog-header' for an alternative format." ;; ------------------------------------------------------------------------ (define-skeleton verilog-sk-ovm-class - "Insert a class definition" + "Insert a class definition." () > "class " (setq name (skeleton-read "Name: ")) " extends " (skeleton-read "Extends: ") ";" \n > _ \n @@ -14442,7 +14442,7 @@ See also `verilog-header' for an alternative format." > "endclass" (progn (electric-verilog-terminate-line) nil)) (define-skeleton verilog-sk-uvm-object - "Insert a class definition" + "Insert a class definition." () > "class " (setq name (skeleton-read "Name: ")) " extends " (skeleton-read "Extends: ") ";" \n > _ \n @@ -14456,7 +14456,7 @@ See also `verilog-header' for an alternative format." > "endclass" (progn (electric-verilog-terminate-line) nil)) (define-skeleton verilog-sk-uvm-component - "Insert a class definition" + "Insert a class definition." () > "class " (setq name (skeleton-read "Name: ")) " extends " (skeleton-read "Extends: ") ";" \n > _ \n @@ -14497,8 +14497,7 @@ See also `verilog-header' for an alternative format." > (- verilog-indent-level-behavioral) "endfunction" (progn (electric-verilog-terminate-line) nil)) (define-skeleton verilog-sk-always - "Insert always block. Uses the minibuffer to prompt -for sensitivity list." + "Insert always block. Prompt for sensitivity list." () > "always @ ( /*AUTOSENSE*/ ) begin\n" > _ \n @@ -14513,14 +14512,14 @@ for sensitivity list." > (- verilog-indent-level-behavioral) "end" \n > ) (define-skeleton verilog-sk-specify - "Insert specify block. " + "Insert specify block." () > "specify\n" > _ \n > (- verilog-indent-level-behavioral) "endspecify" \n > ) (define-skeleton verilog-sk-generate - "Insert generate block. " + "Insert generate block." () > "generate\n" > _ \n diff --git a/lisp/progmodes/vhdl-mode.el b/lisp/progmodes/vhdl-mode.el index 3fe67fabf19..fef7dff65e2 100644 --- a/lisp/progmodes/vhdl-mode.el +++ b/lisp/progmodes/vhdl-mode.el @@ -5985,13 +5985,11 @@ corresponding \"begin\" keyword, else return nil." (defconst vhdl-begin-fwd-re "\\b\\(is\\|begin\\|block\\|component\\|generate\\|then\\|else\\|loop\\|process\\|procedural\\(\\s-+body\\)?\\|units\\|use\\|record\\|protected\\(\\s-+body\\)?\\|for\\)\\b\\([^_]\\|\\'\\)" - "A regular expression for searching forward that matches all known -\"begin\" keywords.") + "Regexp for searching forward that matches all known \"begin\" keywords.") (defconst vhdl-begin-bwd-re "\\b\\(is\\|begin\\|block\\|component\\|generate\\|then\\|else\\|loop\\|process\\|procedural\\(\\s-+body\\)?\\|units\\|use\\|record\\|protected\\(\\s-+body\\)?\\|for\\)\\b[^_]" - "A regular expression for searching backward that matches all known -\"begin\" keywords.") + "Regexp for searching backward that matches all known \"begin\" keywords.") (defun vhdl-begin-p (&optional lim) "Return t if we are looking at a real \"begin\" keyword. @@ -6848,7 +6846,7 @@ keyword at PLACEHOLDER, then return the library unit type." )) (defun vhdl-get-block-state (&optional lim) - "Finds and records all the closest opens. + "Find and records all the closest opens. LIM is the furthest back we need to search (it should be the previous libunit keyword)." (let ((here (point)) @@ -7722,13 +7720,13 @@ indentation is done before aligning." (setq copy (cdr copy)))))))) (defun vhdl-align-region-2 (begin end match &optional substr spacing) - "Align a range of lines from BEGIN to END. The regular expression -MATCH must match exactly one field: the whitespace to be -contracted/expanded. The alignment column will equal the -rightmost column of the widest whitespace block. SPACING is -the amount of extra spaces to add to the calculated maximum required. -SPACING defaults to 1 so that at least one space is inserted after -the token in MATCH." + "Align a range of lines from BEGIN to END. +The regular expression MATCH must match exactly one field: the +whitespace to be contracted/expanded. The alignment column will +equal the rightmost column of the widest whitespace block. +SPACING is the amount of extra spaces to add to the calculated +maximum required. SPACING defaults to 1 so that at least one +space is inserted after the token in MATCH." (setq spacing (or spacing 1)) (setq substr (or substr 1)) (save-excursion @@ -7994,8 +7992,9 @@ the token in MATCH." (beginning-of-line 2)))))) (defun vhdl-align-inline-comment-region (beg end &optional spacing no-message) - "Align inline comments within a region. Groups of code lines separated by -empty lines are aligned individually, if `vhdl-align-groups' is non-nil." + "Align inline comments within a region. +Groups of code lines separated by empty lines are aligned +individually, if `vhdl-align-groups' is non-nil." (interactive "r\nP") (save-excursion (let (orig pos) @@ -8044,8 +8043,9 @@ empty lines are aligned individually, if `vhdl-align-groups' is non-nil." (message "Aligning inline comments...done")))) (defun vhdl-align-inline-comment-buffer () - "Align inline comments within buffer. Groups of code lines separated by -empty lines are aligned individually, if `vhdl-align-groups' is non-nil." + "Align inline comments within buffer. +Groups of code lines separated by empty lines are aligned +individually, if `vhdl-align-groups' is non-nil." (interactive) (vhdl-align-inline-comment-region (point-min) (point-max))) @@ -8053,9 +8053,10 @@ empty lines are aligned individually, if `vhdl-align-groups' is non-nil." ;; Fixup whitespace (defun vhdl-fixup-whitespace-region (beg end &optional no-message) - "Fixup whitespace in region. Surround operator symbols by one space, -eliminate multiple spaces (except at beginning of line), eliminate spaces at -end of line, do nothing in comments and strings." + "Fixup whitespace in region. +Surround operator symbols by one space, eliminate multiple +spaces (except at beginning of line), eliminate spaces at end of +line, do nothing in comments and strings." (interactive "r") (unless no-message (message "Fixing up whitespace...")) (save-excursion @@ -8107,9 +8108,10 @@ end of line, do nothing in comments and strings." (unless no-message (message "Fixing up whitespace...done"))) (defun vhdl-fixup-whitespace-buffer () - "Fixup whitespace in buffer. Surround operator symbols by one space, -eliminate multiple spaces (except at beginning of line), eliminate spaces at -end of line, do nothing in comments." + "Fixup whitespace in buffer. +Surround operator symbols by one space, eliminate multiple +spaces (except at beginning of line), eliminate spaces at end of +line, do nothing in comments." (interactive) (vhdl-fixup-whitespace-region (point-min) (point-max))) @@ -10456,8 +10458,8 @@ otherwise." reset)) (defun vhdl-template-standard-package (library package) - "Insert specification of a standard package. Include a library -specification, if not already there." + "Insert specification of a standard package. +Include a library specification, if not already there." (let ((margin (current-indentation))) (unless (equal library "std") (unless (or (save-excursion @@ -13175,7 +13177,7 @@ File statistics: \"%s\"\n\ "Regexp to match start of construct to hide.") (defun vhdl-hs-forward-sexp-func (count) - "Find end of construct to hide (for hideshow). Only searches forward." + "Find end of construct to hide (for hideshow). Only search forward." (let ((pos (point))) (vhdl-prepare-search-2 (beginning-of-line) @@ -13299,7 +13301,8 @@ File statistics: \"%s\"\n\ (goto-char end)))))) (defun vhdl-font-lock-match-item (limit) - "Match, and move over, any declaration item after point. Adapted from + "Match, and move over, any declaration item after point. +Adapted from `font-lock-match-c-style-declaration-item-and-skip-to-next'." (condition-case nil (save-restriction @@ -13750,8 +13753,7 @@ This does background highlighting of translate-off regions.") ;; Variables (defvar vhdl-entity-alist nil - "Cache with entities and corresponding architectures for each -project/directory.") + "Cache with entities and corresponding architectures for each project/directory.") ;; structure: (parenthesized expression means list of such entries) ;; (cache-key ;; (ent-key ent-name ent-file ent-line @@ -15019,8 +15021,7 @@ otherwise use cached data." (declare-function speedbar-goto-this-file "speedbar" (file)) (defun vhdl-speedbar-expand-dirs (_directory) - "Expand subdirectories in DIRECTORY according to - `speedbar-shown-directories'." + "Expand subdirectories in DIRECTORY according to `speedbar-shown-directories'." ;; (nicked from `speedbar-default-directory-list') (let ((sf (cdr (reverse speedbar-shown-directories))) (vhdl-speedbar-update-current-unit nil)) @@ -15836,7 +15837,7 @@ NO-POSITION non-nil means do not re-position cursor." (declare-function speedbar-line-text "speedbar" (&optional p)) (defun vhdl-speedbar-line-text () - "Calls `speedbar-line-text' and removes text properties." + "Call `speedbar-line-text' and remove text properties." (let ((string (speedbar-line-text))) (set-text-properties 0 (length string) nil string) string)) @@ -17074,8 +17075,7 @@ do not print any file names." (or project-options compiler-options))) (defun vhdl-compile () - "Compile current buffer using the VHDL compiler specified in -`vhdl-compiler'." + "Compile current buffer using the VHDL compiler specified in `vhdl-compiler'." (interactive) (vhdl-compile-init) (let* ((project (vhdl-aget vhdl-project-alist vhdl-project)) @@ -17852,8 +17852,7 @@ User Options `vhdl-indent-comment-like-next-code-line': (new) Specify whether comment lines are indented like following code line. `vhdl-array-index-record-field-in-sensitivity-list': (new) - Specify whether to include array indices / record fields in sensitivity list. -") + Specify whether to include array indices / record fields in sensitivity list.") (defconst vhdl-doc-keywords nil diff --git a/lisp/progmodes/xref.el b/lisp/progmodes/xref.el index 0f7a5194977..ab7e8f6e29e 100644 --- a/lisp/progmodes/xref.el +++ b/lisp/progmodes/xref.el @@ -71,7 +71,7 @@ (require 'ring) (require 'project) -(defgroup xref nil "Cross-referencing commands" +(defgroup xref nil "Cross-referencing commands." :version "25.1" :group 'tools) @@ -247,7 +247,7 @@ generic functions.") The result must be a list of xref objects. If IDENTIFIER contains sufficient information to determine a unique definition, -return only that definition. If there are multiple possible +return only that definition. If there are multiple possible definitions, return all of them. If no definitions can be found, return nil. @@ -491,7 +491,7 @@ value." (goto-char pos)) (defun xref--goto-location (location) - "Set buffer and point according to xref-location LOCATION." + "Set buffer and point according to `xref-location' LOCATION." (let ((marker (xref-location-marker location))) (set-buffer (marker-buffer marker)) (xref--goto-char marker))) @@ -499,9 +499,9 @@ value." (defun xref-pop-to-location (item &optional action) "Go to the location of ITEM and display the buffer. ACTION controls how the buffer is displayed: - nil -- switch-to-buffer - `window' -- pop-to-buffer (other window) - `frame' -- pop-to-buffer (other frame) + nil -- `switch-to-buffer' + `window' -- `pop-to-buffer' (other window) + `frame' -- `pop-to-buffer' (other frame) If SELECT is non-nil, select the target window." (let* ((marker (save-excursion (xref-location-marker (xref-item-location item)))) @@ -962,7 +962,7 @@ The window showing the xref buffer will be selected." (put-text-property (+ pos xref-truncation-width) eol 'invisible 'ellipsis)))))) (defun xref--insert-xrefs (xref-alist) - "Insert XREF-ALIST in the current-buffer. + "Insert XREF-ALIST in the current buffer. XREF-ALIST is of the form ((GROUP . (XREF ...)) ...), where GROUP is a string for decoration purposes and XREF is an `xref-item' object." diff --git a/lisp/ps-print.el b/lisp/ps-print.el index c5a48f59aa5..38671b58e2b 100644 --- a/lisp/ps-print.el +++ b/lisp/ps-print.el @@ -450,7 +450,7 @@ Please send all bug fixes and enhancements to ;; (setq ps-left-header (list 'moe-func 'larry-var "(Curly)")) ;; ;; Note that Curly has the PostScript string delimiters inside his quotes -- -;; those aren't misplaced lisp delimiters! +;; those aren't misplaced Lisp delimiters! ;; ;; Without them, PostScript would attempt to call the undefined function Curly, ;; which would result in a PostScript error. @@ -676,7 +676,7 @@ Please send all bug fixes and enhancements to ;; Valid values for `ps-print-control-characters' are: ;; ;; 8-bit This is the value to use when you want an ASCII encoding of -;; any control or non-ASCII character. Control characters are +;; any control or non-ASCII character. Control characters are ;; encoded as "^D", and non-ASCII characters have an ;; octal encoding. ;; @@ -689,7 +689,7 @@ Please send all bug fixes and enhancements to ;; European 8-bits accented characters are printed according ;; the current font. ;; -;; nil No ASCII encoding. Any character is printed according the +;; nil No ASCII encoding. Any character is printed according the ;; current font. ;; ;; Any other value is treated as nil. @@ -968,7 +968,7 @@ Please send all bug fixes and enhancements to ;; ps-font-info-database)) ;; - Now you can use this font family with any size: ;; (setq ps-font-family 'Helvetica) -;; - if you want to use this family in another emacs session, you must put into +;; - if you want to use this family in another Emacs session, you must put into ;; your `~/.emacs': ;; (require 'ps-print) ;; (setq ps-font-info-database (append ...))) @@ -1101,7 +1101,7 @@ Please send all bug fixes and enhancements to ;; ----------------------- ;; ;; As ps-print uses PostScript to print buffers, it is possible to have other -;; attributes associated with faces. So the new attributes used by ps-print +;; attributes associated with faces. So the new attributes used by ps-print ;; are: ;; ;; strikeout - like underline, but the line is in middle of text. @@ -1423,7 +1423,7 @@ Please send all bug fixes and enhancements to ;; * Check `ps-paper-type': Sudhakar Frederick ;; ;; Thanks to Jacques Duthen (Jack) for version 3.4 I -;; started from. [vinicius] +;; started from. [vinicius] ;; ;; Thanks to Jim Thompson for the 2.8 version I started from. [jack] ;; diff --git a/lisp/register.el b/lisp/register.el index 11d98482cb4..e48a09f1574 100644 --- a/lisp/register.el +++ b/lisp/register.el @@ -102,7 +102,7 @@ If nil, do not show register previews, unless `help-char' (or a member of (alist-get register register-alist)) (defun set-register (register value) - "Set contents of Emacs register named REGISTER to VALUE. Returns VALUE. + "Set contents of Emacs register named REGISTER to VALUE. Return VALUE. See the documentation of the variable `register-alist' for possible VALUEs." (setf (alist-get register register-alist) value)) diff --git a/lisp/registry.el b/lisp/registry.el index 258f7fc9046..c10ae91d169 100644 --- a/lisp/registry.el +++ b/lisp/registry.el @@ -60,7 +60,7 @@ ;; The user decides which fields are "precious", F2 for example. When ;; the registry is pruned, any entries without the F2 field will be ;; removed until the size is :max-size * :prune-factor _less_ than the -;; maximum database size. No entries with the F2 field will be removed +;; maximum database size. No entries with the F2 field will be removed ;; at PRUNE TIME, which means it may not be possible to prune back all ;; the way to the target size. @@ -326,7 +326,7 @@ Errors out if the key exists already." Attempts to prune the number of entries down to \(* :max-size :prune-factor) less than the max-size limit, so -pruning doesn't need to happen on every save. Removes only +pruning doesn't need to happen on every save. Removes only entries without the :precious keys, so it may not be possible to reach the target limit. diff --git a/lisp/replace.el b/lisp/replace.el index 947da8a2feb..dfb0a63d1af 100644 --- a/lisp/replace.el +++ b/lisp/replace.el @@ -83,7 +83,7 @@ from Isearch by using a key sequence like `C-s C-s M-%'." "24.3") (defcustom query-replace-from-to-separator " → " "String that separates FROM and TO in the history of replacement pairs. When nil, the pair will not be added to the history (same behavior -as in emacs 24.5)." +as in Emacs 24.5)." :group 'matching :type '(choice (const :tag "Disabled" nil) @@ -796,7 +796,7 @@ of `history-length', which see.") "Overlays used to temporarily highlight occur matches.") (defvar occur-collect-regexp-history '("\\1") - "History of regexp for occur's collect operation") + "History of regexp for occur's collect operation.") (defcustom read-regexp-defaults-function nil "Function that provides default regexp(s) for `read-regexp'. diff --git a/lisp/rfn-eshadow.el b/lisp/rfn-eshadow.el index 378358feac2..3c1958686f3 100644 --- a/lisp/rfn-eshadow.el +++ b/lisp/rfn-eshadow.el @@ -122,7 +122,7 @@ system, `file-name-shadow-properties' is used instead." "Minibuffer setup functions from other packages.") (defvar rfn-eshadow-update-overlay-hook nil - "Customer overlay functions from other packages") + "Customer overlay functions from other packages.") ;;; Internal variables diff --git a/lisp/rtree.el b/lisp/rtree.el index 166c7808184..0eaaa58e6e2 100644 --- a/lisp/rtree.el +++ b/lisp/rtree.el @@ -171,7 +171,7 @@ (setq tree nil)))))))) (defun rtree-delq (tree number) - "Remove NUMBER from TREE destructively. Returns the new tree." + "Remove NUMBER from TREE destructively. Return the new tree." (let ((result tree) prev) (while tree diff --git a/lisp/saveplace.el b/lisp/saveplace.el index 8225588b9db..4191a3fa62e 100644 --- a/lisp/saveplace.el +++ b/lisp/saveplace.el @@ -55,7 +55,7 @@ This alist is saved between Emacs sessions.") :type 'file) (defcustom save-place-version-control nil - "Controls whether to make numbered backups of master save-place file. + "Controls whether to make numbered backups of master `save-place' file. It can have four values: t, nil, `never', and `nospecial'. The first three have the same meaning that they do for the variable `version-control', and the final value `nospecial' means just use the diff --git a/lisp/server.el b/lisp/server.el index ac5db197f3e..5dd30db195a 100644 --- a/lisp/server.el +++ b/lisp/server.el @@ -881,7 +881,7 @@ This handles splitting the command if it would be bigger than &optional parameters) (let* ((display (or display (frame-parameter nil 'display) - (error "Please specify display."))) + (error "Please specify display"))) (w (or (cdr (assq 'window-system parameters)) (window-system-for-display display)))) diff --git a/lisp/ses.el b/lisp/ses.el index cc8c35d6997..b831cbb5486 100644 --- a/lisp/ses.el +++ b/lisp/ses.el @@ -454,8 +454,8 @@ functions refer to its value." `(ses-cell--references ,(if col `(ses-get-cell ,row ,col) row))) (defmacro ses-sym-rowcol (sym) - "From a cell-symbol SYM, gets the cons (row . col). A1 => (0 . 0). Result -is nil if SYM is not a symbol that names a cell." + "From a cell-symbol SYM, gets the cons (row . col). A1 => (0 . 0). +Result is nil if SYM is not a symbol that names a cell." (declare (debug t)) `(let ((rc (and (symbolp ,sym) (get ,sym 'ses-cell)))) (if (eq rc :ses-named) @@ -623,7 +623,7 @@ This is a macro to prevent propagate-on-load viruses." t) (defmacro ses-column-printers (printers) - "Load the vector of column printers from the spreadsheet file and checks + "Load the vector of column printers from the spreadsheet file and check them for safety. This is a macro to prevent propagate-on-load viruses." (or (and (vectorp printers) (= (length printers) ses--numcols)) (error "Bad column-printers vector")) @@ -634,14 +634,14 @@ them for safety. This is a macro to prevent propagate-on-load viruses." t) (defmacro ses-default-printer (def) - "Load the global default printer from the spreadsheet file and checks it + "Load the global default printer from the spreadsheet file and check it for safety. This is a macro to prevent propagate-on-load viruses." (setq ses--default-printer (ses-safe-printer def)) (ses-printer-record def) t) (defmacro ses-header-row (row) - "Load the header row from the spreadsheet file and checks it + "Load the header row from the spreadsheet file and check it for safety. This is a macro to prevent propagate-on-load viruses." (or (and (wholenump row) (or (zerop ses--numrows) (< row ses--numrows))) (error "Bad header-row")) @@ -819,8 +819,8 @@ Return nil in case of failure." buffer-undo-list)) (defun ses-reset-header-string () - "Flag the header string for update. Upon undo, the header string will be -updated again." + "Flag the header string for update. +Upon undo, the header string will be updated again." (push '(apply ses-reset-header-string) buffer-undo-list) (setq ses--header-hscroll -1)) @@ -1898,7 +1898,7 @@ Does not execute cell formulas or print functions." (or (and (= (following-char) ?\n) (eq (car-safe x) 'ses-local-printer) (apply #'ses--local-printer (cdr x))) - (error "local printer-def error")) + (error "Local printer-def error")) (setq ses--numlocprn (1+ ses--numlocprn)))))) ;; Load cell definitions. (dotimes (row ses--numrows) @@ -2594,8 +2594,7 @@ With prefix, deletes several cells." (forward-char 1)))) (defun ses-clear-cell-backward (count) - "Move to previous cell and then delete it. With prefix, delete several -cells." + "Move to previous cell and then delete it. With prefix, delete several cells." (interactive "*p") (if (< count 0) (1value (ses-clear-cell-forward (- count))) @@ -3054,8 +3053,9 @@ hard to override how mouse-1 works." (advice-add 'copy-region-as-kill :around #'ses--advice-copy-region-as-kill) (defun ses-copy-region (beg end) - "Treat the region as rectangular. Convert the intangible attributes to -SES attributes recording the contents of the cell as of the time of copying." + "Treat the region as rectangular. +Convert the intangible attributes to SES attributes recording the +contents of the cell as of the time of copying." (when (= end ses--data-marker) ;;Avoid overflow situation (setq end (1- ses--data-marker))) @@ -3070,7 +3070,7 @@ SES attributes recording the contents of the cell as of the time of copying." x)) (defun ses-copy-region-helper (line) - "Converts one line (of a rectangle being extracted from a spreadsheet) to + "Convert one line (of a rectangle being extracted from a spreadsheet) to external form by attaching to each print cell a `ses' attribute that records the corresponding data cell." (or (> (length line) 1) @@ -3172,8 +3172,8 @@ 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 -cells, else return nil. The cells are reprinted--the supplied text is + "If TEXT has a proper set of `ses' attributes, insert it as cells. +Otherwise, 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 formulas are to be inserted without relocation." @@ -3743,7 +3743,7 @@ Uses the value COMPILED-VALUE for this printer." (defun ses-define-local-printer (name definition) "Define a local printer with name NAME and definition DEFINITION. -NAME shall be a symbol. Use TAB to complete over existing local +NAME shall be a symbol. Use TAB to complete over existing local printer names. DEFINITION shall be either a string formatter, e.g.: @@ -4012,8 +4012,9 @@ Use `math-format-value' as a printer for Calc objects." (apply #'+ (apply #'ses-delete-blanks args))) (defun ses-average (list) - "Computes the sum of the numbers in LIST, divided by their length. Blanks -are ignored. Result is always floating-point, even if all args are integers." + "Calculate the sum of the numbers in LIST, divided by their length. +Blanks are ignored. Result is always floating-point, even if all +args are integers." (setq list (apply #'ses-delete-blanks list)) (/ (float (apply #'+ list)) (length list))) diff --git a/lisp/simple.el b/lisp/simple.el index 14e5abc87d5..13a0d2196a3 100644 --- a/lisp/simple.el +++ b/lisp/simple.el @@ -259,7 +259,7 @@ all other buffers." extra-test-exclusive) "Try the current buffer when outside navigation. But return nil if we navigated to the current buffer by the means -of `next-error' command. Otherwise, return it if it's next-error +of `next-error' command. Otherwise, return it if it's `next-error' capable." ;; Check that next-error-buffer has no buffer-local value ;; (i.e. we never navigated to the current buffer from another), @@ -7911,8 +7911,8 @@ With argument 0, interchanges line point is in with line mark is in." (defun transpose-subr (mover arg &optional special) "Subroutine to do the work of transposing objects. Works for lines, sentences, paragraphs, etc. MOVER is a function that -moves forward by units of the given object (e.g. forward-sentence, -forward-paragraph). If ARG is zero, exchanges the current object +moves forward by units of the given object (e.g. `forward-sentence', +`forward-paragraph'). If ARG is zero, exchanges the current object with the one containing mark. If ARG is an integer, moves the current object past ARG following (if ARG is positive) or preceding (if ARG is negative) objects, leaving point after the diff --git a/lisp/so-long.el b/lisp/so-long.el index c39c3ecaf3f..0cc6e884b81 100644 --- a/lisp/so-long.el +++ b/lisp/so-long.el @@ -491,7 +491,7 @@ ;; considered internal-use only (with `global-so-long-mode' the interface ;; for enabling or disabling the automated behaviour). FIXME: Establish a ;; way to support the original use-case, or rename to `so-long--enabled'. - "Internal use. Non-nil when any so-long functionality has been used.") + "Internal use. Non-nil when any `so-long' functionality has been used.") (defvar-local so-long--active nil ; internal use "Non-nil when `so-long' mitigations are in effect.") @@ -761,7 +761,7 @@ place of `so-long-mode' -- therefore respecting the file-local mode value, yet still overriding minor modes and variables (as if `so-long-action' had been set to `so-long-minor-mode'). -The value `so-long-inhibit' means that so-long will not take any action at all +The value `so-long-inhibit' means that `so-long' will not take any action at all for this file. If nil, then do not treat files with file-local modes any differently to other @@ -1090,7 +1090,7 @@ This command calls `so-long' with the selected action as an argument.") ;;;###autoload (defun so-long-commentary () - "View the so-long documentation in `outline-mode'." + "View the `so-long' documentation in `outline-mode'." (interactive) (let ((buf "*So Long: Commentary*")) (when (buffer-live-p (get-buffer buf)) @@ -1130,7 +1130,7 @@ This command calls `so-long' with the selected action as an argument.") ;;;###autoload (defun so-long-customize () - "Open the so-long `customize' group." + "Open the `so-long' customize group." (interactive) (customize-group 'so-long)) @@ -1583,7 +1583,7 @@ because we do not want to downgrade the major mode in that scenario." so-long-revert-function 'turn-off-so-long-minor-mode)))) (defun so-long-inhibit (&optional _mode) - "Prevent so-long from having any effect at all. + "Prevent `so-long' from having any effect at all. This is a `so-long-file-local-mode-function' option." (setq so-long--inhibited t)) @@ -1848,14 +1848,14 @@ invoked." ;;;###autoload (defun so-long-enable () - "Enable the so-long library's functionality. + "Enable the `so-long' library's functionality. Equivalent to calling (global-so-long-mode 1)" (interactive) (global-so-long-mode 1)) (defun so-long-disable () - "Disable the so-long library's functionality. + "Disable the `so-long' library's functionality. Equivalent to calling (global-so-long-mode 0)" (interactive) diff --git a/lisp/sort.el b/lisp/sort.el index 0d2fd416649..72df83aaffc 100644 --- a/lisp/sort.el +++ b/lisp/sort.el @@ -56,12 +56,12 @@ The variable `sort-fold-case' determines whether alphabetic case affects the sort order. The next four arguments are functions to be called to move point -across a sort record. They will be called many times from within sort-subr. +across a sort record. They will be called many times from within `sort-subr'. NEXTRECFUN is called with point at the end of the previous record. It moves point to the start of the next record. It should move point to the end of the buffer if there are no more records. -The first record is assumed to start at the position of point when sort-subr +The first record is assumed to start at the position of point when `sort-subr' is called. ENDRECFUN is called with point within the record. diff --git a/lisp/subr.el b/lisp/subr.el index b80d1c28385..a2266b1d576 100644 --- a/lisp/subr.el +++ b/lisp/subr.el @@ -486,7 +486,7 @@ was called." "Return VALUE with its bits shifted left by COUNT. If COUNT is negative, shifting is actually to the right. In this case, if VALUE is a negative fixnum treat it as unsigned, -i.e., subtract 2 * most-negative-fixnum from VALUE before shifting it." +i.e., subtract 2 * `most-negative-fixnum' from VALUE before shifting it." (when (and (< value 0) (< count 0)) (when (< value most-negative-fixnum) (signal 'args-out-of-range (list value count))) @@ -2902,7 +2902,7 @@ function is used instead (see `read-char-choice-with-read-key')." Any input that is not one of CHARS is ignored. If optional argument INHIBIT-KEYBOARD-QUIT is non-nil, ignore -keyboard-quit events while waiting for a valid input. +`keyboard-quit' events while waiting for a valid input. If you bind the variable `help-form' to a non-nil value while calling this function, then pressing `help-char' @@ -5274,7 +5274,7 @@ that can be added. If `buffer-invisibility-spec' isn't a list before calling this function, `buffer-invisibility-spec' will afterwards be a list with the value `(t ELEMENT)'. This means that if text exists -that invisibility values that aren't either `t' or ELEMENT, that +that invisibility values that aren't either t or ELEMENT, that text will become visible." (if (eq buffer-invisibility-spec t) (setq buffer-invisibility-spec (list t))) @@ -5284,8 +5284,8 @@ text will become visible." (defun remove-from-invisibility-spec (element) "Remove ELEMENT from `buffer-invisibility-spec'. If `buffer-invisibility-spec' isn't a list before calling this -function, it will be made into a list containing just `t' as the -only list member. This means that if text exists with non-`t' +function, it will be made into a list containing just t as the +only list member. This means that if text exists with non-t invisibility values, that text will become visible." (setq buffer-invisibility-spec (if (consp buffer-invisibility-spec) diff --git a/lisp/t-mouse.el b/lisp/t-mouse.el index ec36f543789..e9de31f50d7 100644 --- a/lisp/t-mouse.el +++ b/lisp/t-mouse.el @@ -25,7 +25,7 @@ ;;; Commentary: ;; This package provides access to mouse event as reported by the gpm-Linux -;; package. It tries to reproduce the functionality offered by Emacs under X. +;; package. It tries to reproduce the functionality offered by Emacs under X. ;; The "gpm" server runs under Linux, so this package is rather ;; Linux-dependent. diff --git a/lisp/tab-bar.el b/lisp/tab-bar.el index 599fe743167..5abc25b203d 100644 --- a/lisp/tab-bar.el +++ b/lisp/tab-bar.el @@ -189,7 +189,7 @@ either 1 or 0 depending on the value of the customizable variable (defun tab-bar--update-tab-bar-lines (&optional frames) "Update the `tab-bar-lines' frame parameter in FRAMES. If the optional parameter FRAMES is omitted, update only -the currently selected frame. If it is `t', update all frames +the currently selected frame. If it is t, update all frames as well as the default for new frames. Otherwise FRAMES should be a list of frames to update." (let ((frame-lst (cond ((null frames) @@ -1319,7 +1319,7 @@ If `recent', select the most recently visited tab." "Defines what to do when the last tab is closed. If nil, do nothing and show a message, like closing the last window or frame. If `delete-frame', delete the containing frame, as a web browser would do. -If `tab-bar-mode-disable', disable tab-bar-mode so that tabs no longer show +If `tab-bar-mode-disable', disable `tab-bar-mode' so that tabs no longer show in the frame. If the value is a function, call that function with the tab to be closed as an argument." diff --git a/lisp/tar-mode.el b/lisp/tar-mode.el index 411c71cd8c4..db655619bed 100644 --- a/lisp/tar-mode.el +++ b/lisp/tar-mode.el @@ -360,7 +360,7 @@ of the file header. This is used for \"old GNU\" Tar format." #'tar-parse-octal-integer "27.1") (defun tar-parse-octal-integer-safe (string) - (if (zerop (length string)) (error "empty string")) + (if (zerop (length string)) (error "Empty string")) (mapc (lambda (c) (if (or (< c ?0) (> c ?7)) (error "`%c' is not an octal digit" c))) @@ -372,7 +372,7 @@ of the file header. This is used for \"old GNU\" Tar format." The header will lack a proper checksum; use `tar-header-block-checksum' to compute one, or request `tar-header-serialize' to do that. -Other tar-mode facilities may also require the data-start header +Other `tar-mode' facilities may also require the data-start header field to be set to a valid value. If SIZE is not given or nil, it defaults to 0. @@ -1241,7 +1241,7 @@ for this to be permanent." (interactive (list (read-string "New name: " (tar-header-name (tar-current-descriptor))))) - (if (string= "" new-name) (error "zero length name")) + (if (string= "" new-name) (error "Zero length name")) (let ((encoded-new-name (encode-coding-string new-name tar-file-name-coding-system)) (descriptor (tar-current-descriptor)) @@ -1259,7 +1259,7 @@ for this to be permanent." (setq prefix (substring encoded-new-name 0 (match-beginning 0))) (setq encoded-new-name (substring encoded-new-name (match-end 0)))) - (if (> (length encoded-new-name) 98) (error "name too long")) + (if (> (length encoded-new-name) 98) (error "Name too long")) (setf (tar-header-name descriptor) new-name) (tar-alter-one-field 0 (substring (concat encoded-new-name (make-string 99 0)) 0 99)) diff --git a/lisp/tempo.el b/lisp/tempo.el index 87e274a527c..25f54af3c9d 100644 --- a/lisp/tempo.el +++ b/lisp/tempo.el @@ -25,22 +25,22 @@ ;;; Commentary: ;; This file provides a simple way to define powerful templates, or -;; macros, if you wish. It is mainly intended for, but not limited to, +;; macros, if you wish. It is mainly intended for, but not limited to, ;; other programmers to be used for creating shortcuts for editing -;; certain kind of documents. It was originally written to be used by +;; certain kind of documents. It was originally written to be used by ;; a HTML editing mode written by Nelson Minar , ;; and his html-helper-mode.el is probably the best example of how to ;; use this program. ;; A template is defined as a list of items to be inserted in the -;; current buffer at point. Some of the items can be simple strings, +;; current buffer at point. Some of the items can be simple strings, ;; while other can control formatting or define special points of ;; interest in the inserted text. ;; If a template defines a "point of interest" that point is inserted ;; in a buffer-local list of "points of interest" that the user can ;; jump between with the commands `tempo-backward-mark' and -;; `tempo-forward-mark'. If the template definer provides a prompt for +;; `tempo-forward-mark'. If the template definer provides a prompt for ;; the point, and the variable `tempo-interactive' is non-nil, the ;; user will be prompted for a string to be inserted in the buffer, ;; using the minibuffer. @@ -49,21 +49,21 @@ ;; current region if the template command is called with a prefix (or ;; a non-nil argument). -;; More flexible templates can be created by including lisp symbols, +;; More flexible templates can be created by including Lisp symbols, ;; which will be evaluated as variables, or lists, which will be -;; evaluated as lisp expressions. +;; evaluated as Lisp expressions. ;; See the documentation for tempo-define-template for the different ;; items that can be used to define a tempo template. ;; One of the more powerful features of tempo templates are automatic -;; completion. With every template can be assigned a special tag that +;; completion. With every template can be assigned a special tag that ;; should be recognized by `tempo-complete-tag' and expanded to the -;; complete template. By default the tags are added to a global list +;; complete template. By default the tags are added to a global list ;; of template tags, and are matched against the last word before -;; point. But if you assign your tags to a specific list, you can also +;; point. But if you assign your tags to a specific list, you can also ;; specify another method for matching text in the buffer against the -;; tags. In the HTML mode, for instance, the tags are matched against +;; tags. In the HTML mode, for instance, the tags are matched against ;; the text between the last `<' and point. ;; When defining a template named `foo', a symbol named @@ -177,7 +177,7 @@ If `tempo-match-finder' is a string, it should contain a regular expression with at least one \\( \\) pair. When searching for tags, `tempo-complete-tag' calls `re-search-backward' with this string, and the string between the first \\( and \\) is used for matching against -each string in the tag list. If one is found, the whole text between +each string in the tag list. If one is found, the whole text between the first \\( and the point is replaced with the inserted template. You will probably want to include \\=\\= at the end of the regexp to @@ -247,7 +247,7 @@ The elements in ELEMENTS can be of several types: happens when you call the template function with a prefix argument. - (s NAME): Inserts text previously read with the (p ..) construct. Finds the insertion saved under NAME and inserts it. Acts like `p' - if tempo-interactive is nil. + if `tempo-interactive' is nil. - `&': If there is only whitespace between the line start and point, nothing happens. Otherwise a newline is inserted. - `%': If there is only whitespace between point and end of line, @@ -319,8 +319,8 @@ mode, ON-REGION is ignored and assumed true if the region is active." ;;; tempo-insert (defun tempo-insert (element on-region) - "Insert a template element. -Insert one element from a template. If ON-REGION is non-nil the `r' + "Insert a template ELEMENT. +Insert one element from a template. If ON-REGION is non-nil the `r' elements are replaced with the current region. See documentation for `tempo-define-template' for the kind of elements @@ -465,7 +465,7 @@ never prompted." ;;; tempo-save-named (defun tempo-save-named (name data) ; Had an optional prompt for 'v - "Save some data for later insertion + "Save some data for later insertion. The contents of DATA is saved under the name NAME. The data can later be retrieved with `tempo-lookup-named'. @@ -615,7 +615,7 @@ COMPLETION-FUNCTION just sets `tempo-match-finder' locally." ;;; tempo-invalidate-collection (defun tempo-invalidate-collection (&optional global) - "Marks the tag collection as obsolete. + "Mark the tag collection as obsolete. Whenever it is needed again it will be rebuilt. If GLOBAL is non-nil, mark the tag collection of all buffers as obsolete, not just the current one." diff --git a/lisp/term.el b/lisp/term.el index 0bcd095283a..caa3b39be49 100644 --- a/lisp/term.el +++ b/lisp/term.el @@ -35,7 +35,7 @@ ;; This file defines a general command-interpreter-in-a-buffer package ;; (term mode). The idea is that you can build specific process-in-a-buffer -;; modes on top of term mode -- e.g., lisp, shell, scheme, T, soar, .... +;; modes on top of term mode -- e.g., Lisp, shell, Scheme, T, soar, .... ;; This way, all these specific packages share a common base functionality, ;; and a common set of bindings, which makes them easier to use (and ;; saves code, implementation time, etc., etc.). diff --git a/lisp/term/ns-win.el b/lisp/term/ns-win.el index af1e388c2a3..1a3811a37c2 100644 --- a/lisp/term/ns-win.el +++ b/lisp/term/ns-win.el @@ -586,8 +586,8 @@ string dropped into the current buffer." ;; Based on a function by David Reitter ; ;; see https://lists.gnu.org/r/emacs-devel/2005-09/msg00681.html . (defun ns-toggle-toolbar (&optional frame) - "Switches the tool bar on and off in frame FRAME. - If FRAME is nil, the change applies to the selected frame." + "Switch the tool bar on and off in frame FRAME. +If FRAME is nil, the change applies to the selected frame." (interactive) (modify-frame-parameters frame (list (cons 'tool-bar-lines diff --git a/lisp/term/sun.el b/lisp/term/sun.el index 3dfd4c697a2..4c88c80bf7b 100644 --- a/lisp/term/sun.el +++ b/lisp/term/sun.el @@ -38,7 +38,7 @@ (scroll-up n)) (defun kill-region-and-unmark (beg end) - "Like `kill-region', but pops the mark [which equals point, anyway.]" + "Like `kill-region', but pops the mark [which equals point, anyway]." (interactive "r") (kill-region beg end) (setq this-command 'kill-region-and-unmark) @@ -49,7 +49,7 @@ (interactive) (eval (nth 0 command-history))) -(defvar grep-arg nil "Default arg for RE-search") +(defvar grep-arg nil "Default arg for RE-search.") (defun grep-arg () (if (memq last-command '(research-forward research-backward)) grep-arg (let* ((command (car command-history)) diff --git a/lisp/term/x-win.el b/lisp/term/x-win.el index 8c6c75e7e22..d6e63187487 100644 --- a/lisp/term/x-win.el +++ b/lisp/term/x-win.el @@ -131,7 +131,7 @@ When a session manager tells Emacs that the window system is shutting down, this function is called. It calls the functions in the hook `emacs-save-session-functions'. Functions are called with the current buffer set to a temporary buffer. Functions should use `insert' to insert -lisp code to save the session state. The buffer is saved in a file in the +Lisp code to save the session state. The buffer is saved in a file in the home directory of the user running Emacs. The file is evaluated when Emacs is restarted by the session manager. diff --git a/lisp/term/xterm.el b/lisp/term/xterm.el index 95187d5d117..52a64d6c414 100644 --- a/lisp/term/xterm.el +++ b/lisp/term/xterm.el @@ -790,14 +790,13 @@ Return the pasted text as a string." Can be nil to mean \"no timeout\".") (defvar xterm-query-redisplay-timeout 0.2 - "Seconds to wait before allowing redisplay during terminal - query." ) + "Seconds to wait before allowing redisplay during terminal query." ) (defun xterm--read-event-for-query () - "Like read-event, but inhibit redisplay. + "Like `read-event', but inhibit redisplay. By not redisplaying right away for xterm queries, we can avoid -unsightly flashing during initialization. Give up and redisplay +unsightly flashing during initialization. Give up and redisplay anyway if we've been waiting a little while." (let ((start-time (current-time))) (or (let ((inhibit-redisplay t)) diff --git a/lisp/textmodes/artist.el b/lisp/textmodes/artist.el index d9a83c566b4..5e706327edc 100644 --- a/lisp/textmodes/artist.el +++ b/lisp/textmodes/artist.el @@ -4891,7 +4891,7 @@ If optional argument STATE is positive, turn borders on." (+ window-y window-start-y)))) (defun artist--adjust-x (x) - "Adjust the X position wrt. `display-line-numbers-mode'." + "Adjust the X position with regards to `display-line-numbers-mode'." (let ((adjust (line-number-display-width))) (if (= adjust 0) x diff --git a/lisp/textmodes/bibtex.el b/lisp/textmodes/bibtex.el index d5671ce14f9..237a1d99353 100644 --- a/lisp/textmodes/bibtex.el +++ b/lisp/textmodes/bibtex.el @@ -1569,8 +1569,8 @@ Set this variable before loading BibTeX mode." km) "Keymap used in BibTeX mode.") -(easy-menu-define - bibtex-edit-menu bibtex-mode-map "BibTeX-Edit Menu in BibTeX mode" +(easy-menu-define bibtex-edit-menu bibtex-mode-map + "BibTeX-Edit Menu in BibTeX mode." '("BibTeX-Edit" ("Moving inside an Entry" ["End of Field" bibtex-find-text t] diff --git a/lisp/textmodes/conf-mode.el b/lisp/textmodes/conf-mode.el index 57ec8a04289..30f8fd0ca91 100644 --- a/lisp/textmodes/conf-mode.el +++ b/lisp/textmodes/conf-mode.el @@ -615,7 +615,7 @@ For details see `conf-mode'. Example: (conf-mode-initialize "!")) (defun conf-toml-recognize-section (limit) - "Font-lock helper function for conf-toml-mode. + "Font-lock helper function for `conf-toml-mode'. Handles recognizing TOML section names, like [section], \[[section]], or [something.\"else\".section]." (save-excursion diff --git a/lisp/textmodes/fill.el b/lisp/textmodes/fill.el index f394171fb6c..81d908c95e7 100644 --- a/lisp/textmodes/fill.el +++ b/lisp/textmodes/fill.el @@ -1064,7 +1064,7 @@ than line breaks untouched, and fifth arg TO-EOP non-nil means to keep filling to the end of the paragraph (or next hard newline, if variable `use-hard-newlines' is on). -Return the fill-prefix used for filling the last paragraph. +Return the `fill-prefix' used for filling the last paragraph. If `sentence-end-double-space' is non-nil, then period followed by one space does not end a sentence, so don't break a line there." diff --git a/lisp/textmodes/ispell.el b/lisp/textmodes/ispell.el index 0d95b4c1151..5842bf5f9f5 100644 --- a/lisp/textmodes/ispell.el +++ b/lisp/textmodes/ispell.el @@ -621,7 +621,7 @@ this would require some extra guessing in `ispell-aspell-find-dictionary'.") ("svenska" "sv_SE") ("hebrew" "he_IL")) "Alist with known matching locales for standard dict names in - `ispell-dictionary-base-alist'.") +`ispell-dictionary-base-alist'.") ;;; ********************************************************************** diff --git a/lisp/textmodes/picture.el b/lisp/textmodes/picture.el index a9b7b6dc964..cb7f275ea6f 100644 --- a/lisp/textmodes/picture.el +++ b/lisp/textmodes/picture.el @@ -699,10 +699,10 @@ afterwards settable by these commands: Move southwest (sw) after insertion: \\[picture-movement-sw] Move southeast (se) after insertion: \\[picture-movement-se] - Move westnorthwest (wnw) after insertion: C-u \\[picture-movement-nw] - Move eastnortheast (ene) after insertion: C-u \\[picture-movement-ne] - Move westsouthwest (wsw) after insertion: C-u \\[picture-movement-sw] - Move eastsoutheast (ese) after insertion: C-u \\[picture-movement-se] + Move westnorthwest (wnw) after insertion: \\[universal-argument] \\[picture-movement-nw] + Move eastnortheast (ene) after insertion: \\[universal-argument] \\[picture-movement-ne] + Move westsouthwest (wsw) after insertion: \\[universal-argument] \\[picture-movement-sw] + Move eastsoutheast (ese) after insertion: \\[universal-argument] \\[picture-movement-se] The current direction is displayed in the mode line. The initial direction is right. Whitespace is inserted and tabs are changed to diff --git a/lisp/textmodes/reftex-cite.el b/lisp/textmodes/reftex-cite.el index a2b745b0af1..4ca0a5bba82 100644 --- a/lisp/textmodes/reftex-cite.el +++ b/lisp/textmodes/reftex-cite.el @@ -221,7 +221,7 @@ Return list with entries." (if (string-match "\\`[ \t]*\\'" (or first-re "")) (user-error "Empty regular expression")) (if (string-match first-re "") - (user-error "Regular expression matches the empty string.")) + (user-error "Regular expression matches the empty string")) (save-excursion (save-window-excursion diff --git a/lisp/textmodes/reftex-index.el b/lisp/textmodes/reftex-index.el index 5674d31c81b..cba514ea550 100644 --- a/lisp/textmodes/reftex-index.el +++ b/lisp/textmodes/reftex-index.el @@ -842,7 +842,7 @@ The function will go to the section where the entry at point was defined." (reftex-display-index nil nil 'redo)) (defun reftex-index-restrict-to-section (&optional force) - "Restrict index to entries defined in same document sect. as entry at point." + "Restrict index to entries defined in same document section as entry at point." ;; Optional FORCE means, even if point is not on an index entry. (interactive) (let* ((data (get-text-property (point) :data)) diff --git a/lisp/textmodes/reftex.el b/lisp/textmodes/reftex.el index 1278e4c403c..c926b056341 100644 --- a/lisp/textmodes/reftex.el +++ b/lisp/textmodes/reftex.el @@ -2140,7 +2140,7 @@ IGNORE-WORDS List of words which should be removed from the string." (make-variable-buffer-local 'reftex-isearch-minor-mode) (easy-menu-define reftex-mode-menu reftex-mode-map - "Menu used in RefTeX mode" + "Menu used in RefTeX mode." `("Ref" ["Table of Contents" reftex-toc t] ["Recenter TOC" reftex-toc-recenter t] diff --git a/lisp/textmodes/table.el b/lisp/textmodes/table.el index 50e44ff6367..fef5ad2c7ac 100644 --- a/lisp/textmodes/table.el +++ b/lisp/textmodes/table.el @@ -1190,7 +1190,7 @@ executing body forms.") ;; register table menu under global tools menu (easy-menu-define table-global-menu-map nil - "Table global menu" table-global-menu) + "Table global menu." table-global-menu) (easy-menu-add-item (current-global-map) '("menu-bar" "tools") "--") (easy-menu-add-item (current-global-map) '("menu-bar" "tools") table-global-menu-map) @@ -2368,7 +2368,9 @@ table's rectangle structure." "Move point forward to the beginning of the next cell. With argument ARG, do it ARG times; a negative argument ARG = -N means move backward N cells. -Do not specify NO-RECOGNIZE and UNRECOGNIZE. They are for internal use only. + +Do not specify NO-RECOGNIZE and UNRECOGNIZE. They are for +internal use only. Sample Cell Traveling Order (In Irregular Table Cases) @@ -2399,8 +2401,7 @@ You can actually try how it works in this buffer. Press +--+ |4 | |4 | +--+ |5 +--+--+6 | |3 +--+--+4 | |5 | |6 | |5 +--+ | | +--+5 | | |7 |8 | | | |5 |6 | | | | | | | |6 | | | |6 | | +--+--+--+--+ +--+--+--+--+ +--+-----+--+ -+--+--+--+ +--+--+--+ -" ++--+--+--+ +--+--+--+" ;; After modifying this function, test against the above tables in ;; the doc string. It is quite tricky. The tables above do not ;; mean to cover every possible cases of cell layout, of course. @@ -2915,8 +2916,7 @@ LaTeX: CALS (DocBook DTD): URL `https://www.oasis-open.org/html/a502.htm' - URL `https://www.oreilly.com/catalog/docbook/chapter/book/table.html#AEN114751' -" + URL `https://www.oreilly.com/catalog/docbook/chapter/book/table.html#AEN114751'" (interactive (let* ((_ (unless (table--probe-cell) (error "Table not found here"))) (completion-ignore-case t) @@ -3206,7 +3206,7 @@ CALS (DocBook DTD): (insert ?\n)))))) (defun table--cell-horizontal-char-p (c) - "Test if character C is one of the horizontal characters" + "Test if character C is one of the horizontal characters." (memq c (string-to-list table-cell-horizontal-chars))) (defun table--generate-source-scan-lines (dest-buffer _language origin-cell tail-cell col-list row-list) @@ -5289,7 +5289,7 @@ Current buffer must already be set to the cache buffer." (set-marker marker-point nil))) (defun table--fill-region-strictly (beg end) - "Fill region strictly so that no line exceeds fill-column. + "Fill region strictly so that no line exceeds `fill-column'. When a word exceeds fill-column the word is chopped into pieces. The chopped location is indicated with table-word-continuation-char." (or (and (markerp beg) (markerp end)) diff --git a/lisp/textmodes/texinfmt.el b/lisp/textmodes/texinfmt.el index 977f3bab6ce..604a67df323 100644 --- a/lisp/textmodes/texinfmt.el +++ b/lisp/textmodes/texinfmt.el @@ -1618,7 +1618,7 @@ Used by @refill indenting command to avoid indenting within lists, etc.") (if (and (symbolp (car (cdr (car texinfo-stack)))) (> 1 (length (symbol-name (car (cdr (car texinfo-stack))))))) (error - "@enumerate: Use a number or letter, eg: 1, A, a, 3, B, or d." )) + "@enumerate: Use a number or letter, eg: 1, A, a, 3, B, or d")) (texinfo-discard-line-with-args) (setq fill-column (- fill-column 5))) @@ -1705,7 +1705,7 @@ Used by @refill indenting command to avoid indenting within lists, etc.") (if (or (equal ?\[ (string-to-char enumerating-symbol)) (equal ?\{ (string-to-char enumerating-symbol))) (error - "Too many items in enumerated list; alphabet ends at Z.")) + "Too many items in enumerated list; alphabet ends at Z")) (insert ?\b (format "%3s. " enumerating-symbol) ?\n) (setcar (cdr (car texinfo-stack)) (make-symbol @@ -1714,7 +1714,7 @@ Used by @refill indenting command to avoid indenting within lists, etc.") (string-to-char enumerating-symbol)))))) (t (error - "@enumerate: Use a number or letter, eg: 1, A, a, 3, B or d." ))) + "@enumerate: Use a number or letter, eg: 1, A, a, 3, B or d"))) (forward-line -1))) (put 'alphaenumerate 'texinfo-item 'texinfo-alphaenumerate-item) @@ -2032,7 +2032,7 @@ commands that are defined in texinfo.tex for printed output. ;; Case 3: Trouble (t (error - "You probably need to specify column widths for @multitable correctly."))) + "You probably need to specify column widths for @multitable correctly"))) ;; Check whether columns fit on page. (let ((desired-columns (+ @@ -2044,7 +2044,7 @@ commands that are defined in texinfo.tex for printed output. (apply #'+ texinfo-multitable-width-list)))) (if (> desired-columns fill-column) (error - "Multi-column table width, %d chars, is greater than page width, %d chars." + "Multi-column table width, %d chars, is greater than page width, %d chars" desired-columns fill-column))) texinfo-multitable-width-list)) diff --git a/lisp/thingatpt.el b/lisp/thingatpt.el index 8782c9eeb56..0af6d56ccc7 100644 --- a/lisp/thingatpt.el +++ b/lisp/thingatpt.el @@ -31,7 +31,7 @@ ;; The function bounds-of-thing-at-point finds the beginning and end ;; positions by moving first forward to the end of the "thing", and then ;; backwards to the beginning. By default, it uses the corresponding -;; forward-"thing" operator (eg. forward-word, forward-line). +;; forward-"thing" operator (e.g. forward-word, forward-line). ;; ;; Special cases are allowed for using properties associated with the named ;; "thing": diff --git a/lisp/time.el b/lisp/time.el index 9f25f99a149..8496adec228 100644 --- a/lisp/time.el +++ b/lisp/time.el @@ -340,7 +340,7 @@ Switches from the 1 to 5 to 15 minute load average, and then back to 1." (float-time end-time)))))))))) (defun display-time-update () - "Update the display-time info for the mode line. + "Update the `display-time' info for the mode line. However, don't redisplay right now. This is used for things like Rmail `g' that want to force an @@ -626,7 +626,7 @@ point." ;;;###autoload (defun emacs-init-time (&optional format) "Return a string giving the duration of the Emacs initialization. -FORMAT is a string to format the result, using `format'. If nil, +FORMAT is a string to format the result, using `format'. If nil, the default format \"%f seconds\" is used." (interactive) (let ((str (format (or format "%f seconds") diff --git a/lisp/transient.el b/lisp/transient.el index 5f441e80ddd..2be82f56d86 100644 --- a/lisp/transient.el +++ b/lisp/transient.el @@ -266,7 +266,7 @@ discouraged. For example, \"=\" is hard to reach using my custom keyboard layout, so I substitute \"(\" for that, which is easy to reach -using a layout optimized for lisp. +using a layout optimized for Lisp. (setq transient-substitute-key-function (lambda (obj) @@ -3119,19 +3119,19 @@ and its value is returned to the caller." desc))) (cl-defmethod transient-format-description ((obj transient-group)) - "Format the description by calling the next method. If the result -doesn't use the `face' property at all, then apply the face -`transient-heading' to the complete string." + "Format the description by calling the next method. +If the result doesn't use the `face' property at all, then apply +the face `transient-heading' to the complete string." (when-let ((desc (cl-call-next-method obj))) (if (text-property-not-all 0 (length desc) 'face nil desc) desc (propertize desc 'face 'transient-heading)))) (cl-defmethod transient-format-description :around ((obj transient-suffix)) - "Format the description by calling the next method. If the result -is nil, then use \"(BUG: no description)\" as the description. -If the OBJ's `key' is currently unreachable, then apply the face -`transient-unreachable' to the complete string." + "Format the description by calling the next method. +If the result is nil, then use \"(BUG: no description)\" as the +description. If the OBJ's `key' is currently unreachable, then +apply the face `transient-unreachable' to the complete string." (let ((desc (or (cl-call-next-method obj) (and (slot-boundp transient--prefix 'suffix-description) (funcall (oref transient--prefix suffix-description) diff --git a/lisp/url/url-http.el b/lisp/url/url-http.el index ba13a17a8fc..c4a29ebe102 100644 --- a/lisp/url/url-http.el +++ b/lisp/url/url-http.el @@ -1451,8 +1451,8 @@ The return value of this function is the retrieval buffer." (error "gnutls-error: %s" e)) (error (url-http-activate-callback) - (error "error: %s" e))) - (error "error: gnutls support needed!"))) + (error "Error: %s" e))) + (error "Error: gnutls support needed!"))) (t (url-http-debug "error response: %d" url-http-response-status) (url-http-activate-callback)))))) diff --git a/lisp/url/url-imap.el b/lisp/url/url-imap.el index 492907f33ff..f2e9b4c4a1f 100644 --- a/lisp/url/url-imap.el +++ b/lisp/url/url-imap.el @@ -22,8 +22,8 @@ ;;; Commentary: -;; Anyway, here's a teaser. It's quite broken in lots of regards, but at -;; least it seem to work. At least a little. At least when called +;; Anyway, here's a teaser. It's quite broken in lots of regards, but at +;; least it seem to work. At least a little. At least when called ;; manually like this (I've no idea how it's supposed to be called): ;; (url-imap (url-generic-parse-url "imap://cyrus.andrew.cmu.edu/archive.c-client;UID=1021")) diff --git a/lisp/url/url-util.el b/lisp/url/url-util.el index 113ac2833bc..7ffccfd3a0b 100644 --- a/lisp/url/url-util.el +++ b/lisp/url/url-util.el @@ -282,7 +282,7 @@ Given a QUERY in the form: \(This is the same format as produced by `url-parse-query-string') This will return a string -\"key1=val1&key2=val2&key3=val1&key3=val2&key4&key5\". Keys may +\"key1=val1&key2=val2&key3=val1&key3=val2&key4&key5\". Keys may be strings or symbols; if they are symbols, the symbol name will be used. diff --git a/lisp/url/url-vars.el b/lisp/url/url-vars.el index 2aa2e7912f5..f0d70ff6e75 100644 --- a/lisp/url/url-vars.el +++ b/lisp/url/url-vars.el @@ -158,8 +158,7 @@ none -- Always send last location. domain-match -- Send last location if the new location is within the same domain host-match -- Send last location if the new location is on the - same host -" + same host" :version "27.1" :type '(radio (const :tag "Always send" none) (const :tag "Domains match" domain-match) diff --git a/lisp/vc/ediff-init.el b/lisp/vc/ediff-init.el index 5afc83d9e21..1d87b081f2a 100644 --- a/lisp/vc/ediff-init.el +++ b/lisp/vc/ediff-init.el @@ -404,7 +404,7 @@ It needs to be killed when we quit the session.") (defcustom ediff-before-setup-hook nil "Hooks to run before Ediff begins to set up windows and buffers. This hook can be used to save the previous window config, which can be restored -on ediff-quit or ediff-suspend." +on `ediff-quit' or `ediff-suspend'." :type 'hook :group 'ediff-hook) (defcustom ediff-before-setup-windows-hook nil @@ -455,7 +455,7 @@ For each buffer, the hooks are run with that buffer made current." "use `with-eval-after-load' instead." "28.1") (defcustom ediff-mode-hook nil - "Hook run just after ediff-mode is set up in the control buffer. + "Hook run just after `ediff-mode' is set up in the control buffer. This is done before any windows or frames are created. One can use it to set local variables that determine how the display looks like." :type 'hook @@ -1473,7 +1473,7 @@ This default should work without changes." (delete-overlay overlay))))) (defun ediff-overlay-put (overlay prop value) - "Calls `overlay-put', but checks if overlay's buffer exists." + "Call `overlay-put', but check if OVERLAY's buffer exists." (if (ediff-buffer-live-p (overlay-buffer overlay)) (overlay-put overlay prop value) (delete-overlay overlay))) diff --git a/lisp/vc/ediff-vers.el b/lisp/vc/ediff-vers.el index 9e82392725d..0646ba3cc20 100644 --- a/lisp/vc/ediff-vers.el +++ b/lisp/vc/ediff-vers.el @@ -88,8 +88,8 @@ comparison or merge operations are being performed." ;; RCS.el support (defun rcs-ediff-view-revision (&optional rev) -;; View previous RCS revision of current file. -;; With prefix argument, prompts for a revision name. + "View previous RCS revision of current file. +With prefix argument, prompts for a revision name." (interactive (list (if current-prefix-arg (read-string "Revision: ")))) (let* ((filename (buffer-file-name (current-buffer))) diff --git a/lisp/vc/emerge.el b/lisp/vc/emerge.el index 8f7affeea4e..b363fa256b5 100644 --- a/lisp/vc/emerge.el +++ b/lisp/vc/emerge.el @@ -2062,7 +2062,7 @@ With prefix argument, puts point before, mark after." (goto-char opoint)))) (defun emerge-mark-difference (arg) - "Leaves the point before this difference and the mark after it. + "Leave the point before this difference and the mark after it. With prefix argument, puts mark before, point after." (interactive "P") (emerge-validate-difference) @@ -2921,7 +2921,7 @@ around the current difference are removed." ;; Define a key, even if a prefix of it is defined (defun emerge-force-define-key (keymap key definition) - "Like `define-key', but forcibly creates prefix characters as needed. + "Like `define-key', but forcibly create prefix characters as needed. If some prefix of KEY has a non-prefix definition, it is redefined." ;; Find out if a prefix of key is defined (let ((v (lookup-key keymap key))) diff --git a/lisp/vc/vc-cvs.el b/lisp/vc/vc-cvs.el index ec6dc282dc8..6f921ac2a04 100644 --- a/lisp/vc/vc-cvs.el +++ b/lisp/vc/vc-cvs.el @@ -825,7 +825,7 @@ individually should stay local." (line-end-position)))))))) (defun vc-cvs-parse-uhp (path) - "parse user@host/path into (user@host /path)" + "Parse user@host/path into (user@host /path)." (if (string-match "\\([^/]+\\)\\(/.*\\)" path) (list (match-string 1 path) (match-string 2 path)) (list nil path))) diff --git a/lisp/vc/vc-dav.el b/lisp/vc/vc-dav.el index 1785440d538..fe631ee09a7 100644 --- a/lisp/vc/vc-dav.el +++ b/lisp/vc/vc-dav.el @@ -96,8 +96,7 @@ If REV is non-nil, that is the revision to check out. If REV is the empty string, that means to check ou tht ehead of the trunk. If optional arg DESTFILE is given, it is an alternate filename to -write the contents to. -" +write the contents to." ;; This should LOCK the resource. ) @@ -106,8 +105,7 @@ write the contents to. If optional arg CONTENTS-DONE is non-nil, then the contents of FILE have already been reverted from a version backup, and this function -only needs to update the status of URL within the backend. -" +only needs to update the status of URL within the backend." ;; Should do a GET if !contents_done ;; Should UNLOCK the file. ) @@ -123,8 +121,7 @@ If REV1 is nil, use the current workfile version as the older version. If REV2 is nil, use the current workfile contents as the nwer version. It should return a status of either 0 (no differences found), or -1 (either non-empty diff or the diff is run asynchronously). -" +1 (either non-empty diff or the diff is run asynchronously)." ;; We should do this asynchronously... ;; How would we do it at all, that is the question! ) diff --git a/lisp/vc/vc-dir.el b/lisp/vc/vc-dir.el index 26cea0001cc..ebecdff62eb 100644 --- a/lisp/vc/vc-dir.el +++ b/lisp/vc/vc-dir.el @@ -1542,7 +1542,7 @@ This implements the `bookmark-make-record-function' type for ;;;###autoload (defun vc-dir-bookmark-jump (bmk) - "Provides the bookmark-jump behavior for a `vc-dir' buffer. + "Provide the `bookmark-jump' behavior for a `vc-dir' buffer. This implements the `handler' function interface for the record type returned by `vc-dir-bookmark-make-record'." (let* ((file (bookmark-prop-get bmk 'filename)) diff --git a/lisp/vt-control.el b/lisp/vt-control.el index bac0069b852..8f62b5757a3 100644 --- a/lisp/vt-control.el +++ b/lisp/vt-control.el @@ -23,7 +23,7 @@ ;;; Commentary: ;; The functions contained in this file send various VT control codes -;; to the terminal where emacs is running. The following functions are +;; to the terminal where Emacs is running. The following functions are ;; available. ;; Function Action diff --git a/lisp/wdired.el b/lisp/wdired.el index fd549bac322..eafb50cc18a 100644 --- a/lisp/wdired.el +++ b/lisp/wdired.el @@ -689,7 +689,7 @@ Optional arguments are ignored." ;; FIXME: Can't we use the normal mechanism for that? --Stef (if (and (buffer-modified-p) - (not (y-or-n-p "Buffer changed. Discard changes and kill buffer? "))) + (not (y-or-n-p "Buffer changed. Discard changes and kill buffer?"))) (error "Error"))) ;; Added to after-change-functions in wdired-change-to-wdired-mode to diff --git a/lisp/widget.el b/lisp/widget.el index b72f548f508..393fe6c21b3 100644 --- a/lisp/widget.el +++ b/lisp/widget.el @@ -86,7 +86,7 @@ The third argument DOC is a documentation string for the widget." (declare (doc-string 3)) ;; (unless (or (null doc) (stringp doc)) - (error "widget documentation must be nil or a string.")) + (error "Widget documentation must be nil or a string")) (put name 'widget-type (cons class args)) (put name 'widget-documentation (purecopy doc)) name) diff --git a/lisp/windmove.el b/lisp/windmove.el index 47a1668ee88..bb0ece7cbae 100644 --- a/lisp/windmove.el +++ b/lisp/windmove.el @@ -698,8 +698,8 @@ Keys are bound to commands that delete windows in the specified direction. Keybindings are of the form PREFIX MODIFIERS-{left,right,up,down}, where PREFIX is a prefix key and MODIFIERS is either a list of modifiers or a single modifier. -If PREFIX is `none', no prefix is used. If MODIFIERS is `none', the keybindings -are directly bound to the arrow keys. +If PREFIX is `none', no prefix is used. If MODIFIERS is `none', +the keybindings are directly bound to the arrow keys. Default value of PREFIX is `C-x' and MODIFIERS is `shift'." (interactive) (unless prefix (setq prefix '(?\C-x))) diff --git a/lisp/window.el b/lisp/window.el index 3b897eb0bac..a25da0ff1b7 100644 --- a/lisp/window.el +++ b/lisp/window.el @@ -634,7 +634,7 @@ is unpredictable." (defun window-with-parameter (parameter &optional value frame any minibuf) "Return first window on FRAME with PARAMETER non-nil. FRAME defaults to the selected frame. Optional argument VALUE -non-nil means only return a window whose window-parameter value +non-nil means only return a window whose `window-parameter' value for PARAMETER equals VALUE (comparison is done with `equal'). Optional argument ANY non-nil means consider internal windows too. @@ -867,7 +867,7 @@ window annihilates any effect provided by this variable.") (defun window--sides-reverse-on-frame-p (frame) "Return non-nil when side windows should appear reversed on FRAME. This uses some heuristics to guess the user's intentions when the -selected window of FRAME is a side window ." +selected window of FRAME is a side window." (cond ;; Reverse when `window-sides-reversed' is t. Do not reverse when ;; `window-sides-reversed' is nil. @@ -8619,7 +8619,7 @@ the buffer in the window specified by the rules from these variables." WARNING: This is NOT the way to work on another buffer temporarily within a Lisp program! Use `set-buffer' instead. That avoids -messing with the window-buffer correspondences. +messing with the `window-buffer' correspondences. If the selected window cannot display the specified buffer because it is a minibuffer window or strongly dedicated to @@ -8674,7 +8674,7 @@ Return the buffer switched to." "Cannot switch buffers in a dedicated window")) ('prompt (if (y-or-n-p - (format "Window is dedicated to %s; undedicate it" + (format "Window is dedicated to %s; undedicate it?" (window-buffer))) (progn (set-window-dedicated-p nil nil) @@ -10389,7 +10389,7 @@ displaying that processes's buffer." (setq repeat-map 'other-window-repeat-map) (other-window -1))) map) - "Keymap to repeat other-window key sequences. Used in `repeat-mode'.") + "Keymap to repeat `other-window' key sequences. Used in `repeat-mode'.") (put 'other-window 'repeat-map 'other-window-repeat-map) (defvar resize-window-repeat-map diff --git a/lisp/winner.el b/lisp/winner.el index 8062fbae904..1b2807f2482 100644 --- a/lisp/winner.el +++ b/lisp/winner.el @@ -131,8 +131,7 @@ You may want to include buffer names such as *Help*, *Apropos*, (defsubst winner-equal (a b) - "Check whether two Winner configurations (as produced by -`winner-conf') are equal." + "Return t if two Winner configurations (as produced by `winner-conf') are equal." (equal (cdr a) (cdr b))) diff --git a/lisp/xdg.el b/lisp/xdg.el index e5165bbd86a..1f9fa6795e0 100644 --- a/lisp/xdg.el +++ b/lisp/xdg.el @@ -109,7 +109,7 @@ file:///foo/bar.jpg" "_DIR=\"" (group-n 2 (or "/" "$HOME/") (*? (or (not (any "\"")) "\\\""))) "\"")) - "Regexp matching non-comment lines in xdg-user-dirs config files.") + "Regexp matching non-comment lines in `xdg-user-dirs' config files.") (defvar xdg-user-dirs nil "Alist of directory keys and values.") @@ -131,7 +131,7 @@ This should be called at the beginning of a line." (when (and k v) (cons k (xdg--substitute-home-env v)))))) (defun xdg--user-dirs-parse-file (filename) - "Return alist of xdg-user-dirs from FILENAME." + "Return alist of `xdg-user-dirs' from FILENAME." (let (elt res) (when (file-readable-p filename) (with-temp-buffer diff --git a/lisp/xml.el b/lisp/xml.el index 1b2d6557388..0282e3741c0 100644 --- a/lisp/xml.el +++ b/lisp/xml.el @@ -83,7 +83,7 @@ ;;; Macros to parse the list (defconst xml-undefined-entity "?" - "What to substitute for undefined entities") + "What to substitute for undefined entities.") (defconst xml-default-ns '(("" . "") ("xml" . "http://www.w3.org/XML/1998/namespace") diff --git a/lisp/xt-mouse.el b/lisp/xt-mouse.el index 72faff81015..e4e91aa8928 100644 --- a/lisp/xt-mouse.el +++ b/lisp/xt-mouse.el @@ -27,7 +27,7 @@ ;; This is actually useful when you are running X11 locally, but is ;; working on remote machine over a modem line or through a gateway. -;; It works by translating xterm escape codes into generic emacs mouse +;; It works by translating xterm escape codes into generic Emacs mouse ;; events so it should work with any package that uses the mouse. ;; You don't have to turn off xterm mode to use the normal xterm mouse @@ -376,11 +376,11 @@ given escape sequence takes precedence over the former." "\e[?1000h\e[?1003h\e[?1005h\e[?1006h" "Control sequence to enable xterm mouse tracking. Enables basic mouse tracking, mouse motion events and finally -extended tracking on terminals that support it. The following +extended tracking on terminals that support it. The following escape sequences are understood by modern xterms: \"\\e[?1000h\" \"Basic mouse mode\": Enables reports for mouse - clicks. There is a limit to the maximum row/column + clicks. There is a limit to the maximum row/column position (<= 223), which can be reported in this basic mode. @@ -389,7 +389,7 @@ escape sequences are understood by modern xterms: \"\\e[?1005h\" \"UTF-8 coordinate extension\": Enables an extension to the basic mouse mode, which uses UTF-8 - characters to overcome the 223 row/column limit. This + characters to overcome the 223 row/column limit. This extension may conflict with non UTF-8 applications or non UTF-8 locales. diff --git a/test/lisp/abbrev-tests.el b/test/lisp/abbrev-tests.el index 2a42d5636d3..2dcfb1c309e 100644 --- a/test/lisp/abbrev-tests.el +++ b/test/lisp/abbrev-tests.el @@ -106,7 +106,7 @@ (should (abbrev-table-empty-p table)))) (ert-deftest kill-all-abbrevs-test () - "Test undefining all defined abbrevs" + "Test undefining all defined abbrevs." (unless noninteractive (ert-skip "Cannot test kill-all-abbrevs in interactive mode")) @@ -125,14 +125,14 @@ abbrev-table-name-list)))))) (ert-deftest abbrev-table-name-test () - "Test returning name of abbrev-table" + "Test returning name of abbrev-table." (let ((ert-test-abbrevs (setup-test-abbrev-table)) (no-such-table nil)) (should (equal 'ert-test-abbrevs (abbrev-table-name ert-test-abbrevs))) (should (equal nil (abbrev-table-name no-such-table))))) (ert-deftest clear-abbrev-table-test () - "Test clearing single abbrev table" + "Test clearing single abbrev table." (let ((ert-test-abbrevs (setup-test-abbrev-table))) (should (equal "abbrev-ert-test" (abbrev-expansion "a-e-t" ert-test-abbrevs))) (clear-abbrev-table ert-test-abbrevs) @@ -140,7 +140,7 @@ (should (equal t (abbrev-table-empty-p ert-test-abbrevs))))) (ert-deftest list-abbrevs-test () - "Test generation of abbrev list buffer" + "Test generation of abbrev list buffer." ;; Somewhat redundant as prepare-abbrev-list-buffer is also tested. ;; all abbrevs (let ((abbrev-buffer (prepare-abbrev-list-buffer))) @@ -152,7 +152,7 @@ (kill-buffer abbrev-buffer))) (ert-deftest prepare-abbrev-list-buffer-test () - "Test generation of abbrev list buffer" + "Test generation of abbrev list buffer." ;; all abbrevs (let ((ert-test-abbrevs (setup-test-abbrev-table))) (with-current-buffer (prepare-abbrev-list-buffer) @@ -180,7 +180,7 @@ (kill-buffer "*Abbrevs*")))) (ert-deftest insert-abbrevs-test () - "Test inserting abbrev definitions into buffer" + "Test inserting abbrev definitions into buffer." (with-temp-buffer (insert-abbrevs) (should (progn @@ -188,7 +188,7 @@ (search-forward "global-abbrev-table"))))) (ert-deftest edit-abbrevs-test () - "Test editing abbrevs from buffer" + "Test editing abbrevs from buffer." (defvar ert-edit-abbrevs-test-table nil) (let ((ert-test-abbrevs (setup-test-abbrev-table))) (with-temp-buffer @@ -205,7 +205,7 @@ (abbrev-expansion "e-a-t" ert-edit-abbrevs-test-table)))))) (ert-deftest define-abbrevs-test () - "Test defining abbrevs from buffer" + "Test defining abbrevs from buffer." (defvar ert-bad-abbrev-table nil) (defvar ert-good-abbrev-table nil) (defvar ert-redefine-abbrev-table nil) @@ -235,7 +235,7 @@ (should (equal nil (abbrev-expansion "g-a-t" ert-good-abbrev-table))))) (ert-deftest read-write-abbrev-file-test () - "Test reading and writing abbrevs from file" + "Test reading and writing abbrevs from file." (let ((temp-test-file (make-temp-file "ert-abbrev-test")) (ert-test-abbrevs (setup-test-abbrev-table))) (write-abbrev-file temp-test-file) @@ -246,7 +246,7 @@ (delete-file temp-test-file))) (ert-deftest read-write-abbrev-file-test-with-props () - "Test reading and writing abbrevs from file" + "Test reading and writing abbrevs from file." (let ((temp-test-file (make-temp-file "ert-abbrev-test")) (ert-test-abbrevs (setup-test-abbrev-table-with-props))) (write-abbrev-file temp-test-file) @@ -257,7 +257,7 @@ (delete-file temp-test-file))) (ert-deftest abbrev-edit-save-to-file-test () - "Test saving abbrev definitions in buffer to file" + "Test saving abbrev definitions in buffer to file." (defvar ert-save-test-table nil) (let ((temp-test-file (make-temp-file "ert-abbrev-test")) (ert-test-abbrevs (setup-test-abbrev-table))) diff --git a/test/lisp/arc-mode-tests.el b/test/lisp/arc-mode-tests.el index 5c6af9b45cf..b05a9629c16 100644 --- a/test/lisp/arc-mode-tests.el +++ b/test/lisp/arc-mode-tests.el @@ -48,4 +48,4 @@ (provide 'arc-mode-tests) -;; arc-mode-tests.el ends here +;;; arc-mode-tests.el ends here diff --git a/test/lisp/auth-source-tests.el b/test/lisp/auth-source-tests.el index 1c4bd8d36d4..45482e916e8 100644 --- a/test/lisp/auth-source-tests.el +++ b/test/lisp/auth-source-tests.el @@ -247,7 +247,7 @@ (should-not (auth-source-remembered-p '(:host t))))) (ert-deftest auth-source-test-searches () - "Test auth-source searches with various parameters" + "Test auth-source searches with various parameters." :tags '(auth-source auth-source/netrc) (let* ((entries '("machine a1 port a2 user a3 password a4" "machine b1 port b2 user b3 password b4" diff --git a/test/manual/cedet/semantic-tests.el b/test/manual/cedet/semantic-tests.el index 1561c18dd68..044db29cda7 100644 --- a/test/manual/cedet/semantic-tests.el +++ b/test/manual/cedet/semantic-tests.el @@ -24,6 +24,8 @@ ;; Originally, there are many test functions scattered among the ;; Semantic source files. This file consolidates them. +;;; Code: + (require 'data-debug) ;;; From semantic-complete @@ -46,7 +48,7 @@ All systems are different. Ask questions along the way." (interactive) (let ((doload nil)) - (when (y-or-n-p "Create a system database to test with? ") + (when (y-or-n-p "Create a system database to test with?") (call-interactively 'semanticdb-create-ebrowse-database) (setq doload t)) ;; Should we load in caches -- cgit v1.2.3 From aebba085cba13ad1439462923ffa0520456f1aad Mon Sep 17 00:00:00 2001 From: Stefan Kangas Date: Wed, 22 Sep 2021 20:26:40 +0200 Subject: ; More minor stylistic fixes found by checkdoc --- lisp/allout.el | 35 +++++++++--------- lisp/ansi-color.el | 2 +- lisp/apropos.el | 4 +-- lisp/auth-source.el | 8 ++--- lisp/autoinsert.el | 7 ++-- lisp/bindings.el | 6 ++-- lisp/bookmark.el | 17 +++++---- lisp/buff-menu.el | 6 ++-- lisp/button.el | 45 +++++++++++------------ lisp/calc/calc-aent.el | 3 +- lisp/calc/calc-forms.el | 15 ++++---- lisp/calc/calc-poly.el | 2 +- lisp/calc/calc.el | 12 +++---- lisp/calculator.el | 9 +++-- lisp/calendar/diary-lib.el | 7 ++-- lisp/char-fold.el | 2 ++ lisp/cmuscheme.el | 2 +- lisp/comint.el | 2 +- lisp/cus-edit.el | 4 +-- lisp/cus-theme.el | 2 ++ lisp/dabbrev.el | 3 +- lisp/dired-aux.el | 4 +-- lisp/dired-x.el | 4 +-- lisp/dired.el | 5 ++- lisp/display-fill-column-indicator.el | 2 +- lisp/dos-vars.el | 6 ++-- lisp/edmacro.el | 13 +++---- lisp/elec-pair.el | 2 +- lisp/epa-dired.el | 2 ++ lisp/epa-file.el | 3 +- lisp/epa-hook.el | 2 ++ lisp/epa-mail.el | 3 +- lisp/epa.el | 11 +++--- lisp/epg.el | 4 ++- lisp/face-remap.el | 2 +- lisp/faces.el | 4 +-- lisp/ffap.el | 10 +++--- lisp/fileloop.el | 1 + lisp/files.el | 4 +-- lisp/filesets.el | 14 ++++---- lisp/find-dired.el | 2 +- lisp/foldout.el | 2 +- lisp/font-core.el | 2 ++ lisp/forms.el | 4 +-- lisp/hexl.el | 2 +- lisp/hi-lock.el | 2 +- lisp/image-dired.el | 4 +-- lisp/imenu.el | 3 +- lisp/indent.el | 15 ++++---- lisp/info-look.el | 6 ++-- lisp/international/ccl.el | 13 +++---- lisp/international/quail.el | 3 +- lisp/international/robin.el | 3 +- lisp/isearch.el | 2 +- lisp/jit-lock.el | 2 +- lisp/kmacro.el | 4 +-- lisp/loadhist.el | 3 +- lisp/locate.el | 2 +- lisp/macros.el | 13 ++++--- lisp/menu-bar.el | 6 ++-- lisp/mouse-drag.el | 2 +- lisp/mouse.el | 2 +- lisp/nxml/nxml-mode.el | 3 +- lisp/nxml/rng-loc.el | 4 +-- lisp/nxml/rng-valid.el | 5 ++- lisp/pcmpl-x.el | 2 ++ lisp/play/5x5.el | 6 ++-- lisp/play/doctor.el | 4 +-- lisp/play/dunnet.el | 12 +++---- lisp/play/hanoi.el | 2 +- lisp/play/mpuz.el | 2 +- lisp/play/tetris.el | 2 +- lisp/printing.el | 12 +++---- lisp/profiler.el | 6 ++-- lisp/progmodes/cc-bytecomp.el | 30 ++++++++-------- lisp/progmodes/cc-cmds.el | 5 +-- lisp/progmodes/cc-defs.el | 14 ++++---- lisp/progmodes/cc-engine.el | 10 +++--- lisp/progmodes/cc-fonts.el | 2 +- lisp/progmodes/cc-langs.el | 3 +- lisp/progmodes/cc-mode.el | 2 +- lisp/progmodes/cc-vars.el | 2 +- lisp/progmodes/cmacexp.el | 2 +- lisp/progmodes/compile.el | 8 +++-- lisp/progmodes/cperl-mode.el | 4 +-- lisp/progmodes/cpp.el | 6 ++-- lisp/progmodes/dcl-mode.el | 4 +-- lisp/progmodes/ebnf-yac.el | 2 +- lisp/progmodes/f90.el | 6 ++-- lisp/progmodes/flymake.el | 4 +-- lisp/progmodes/gdb-mi.el | 6 ++-- lisp/progmodes/grep.el | 4 +-- lisp/progmodes/hideshow.el | 2 +- lisp/progmodes/idlwave.el | 2 +- lisp/progmodes/opascal.el | 5 +-- lisp/progmodes/prog-mode.el | 4 +-- lisp/progmodes/project.el | 4 +-- lisp/progmodes/verilog-mode.el | 4 +-- lisp/progmodes/vhdl-mode.el | 67 +++++++++++++++++------------------ lisp/progmodes/xref.el | 2 +- lisp/rect.el | 4 +-- lisp/repeat.el | 2 +- lisp/replace.el | 13 +++---- lisp/ruler-mode.el | 2 +- lisp/server.el | 2 +- lisp/ses.el | 10 +++--- lisp/shell.el | 3 +- lisp/simple.el | 18 ++++++---- lisp/so-long.el | 8 ++--- lisp/sort.el | 3 +- lisp/subr.el | 2 ++ lisp/tempo.el | 2 +- lisp/term.el | 38 ++++++++++---------- lisp/textmodes/bib-mode.el | 2 +- lisp/textmodes/flyspell.el | 2 +- lisp/textmodes/makeinfo.el | 7 ++-- lisp/textmodes/mhtml-mode.el | 2 ++ lisp/textmodes/refill.el | 2 +- lisp/textmodes/reftex-dcr.el | 19 +++++----- lisp/textmodes/reftex-global.el | 6 ++-- lisp/textmodes/reftex-index.el | 4 +-- lisp/textmodes/reftex-parse.el | 6 ++-- lisp/textmodes/reftex-vars.el | 9 ++--- lisp/textmodes/texinfmt.el | 14 ++++---- lisp/transient.el | 4 +-- lisp/wdired.el | 4 +-- lisp/whitespace.el | 6 ++-- lisp/wid-edit.el | 7 ++-- lisp/woman.el | 4 +-- 129 files changed, 447 insertions(+), 408 deletions(-) (limited to 'lisp/progmodes/gdb-mi.el') diff --git a/lisp/allout.el b/lisp/allout.el index bb365246587..c123e8ded4c 100644 --- a/lisp/allout.el +++ b/lisp/allout.el @@ -116,7 +116,7 @@ Do NOT set the value of this variable. Instead, customize "Create the allout keymap according to the keybinding specs, and set it. Useful standalone or to effect customizations of the -respective allout-mode keybinding variables, `allout-command-prefix', +respective `allout-mode' keybinding variables, `allout-command-prefix', `allout-prefixed-keybindings', and `allout-unprefixed-keybindings'" ;; Set the customization variable, if any: (when varname @@ -145,7 +145,7 @@ respective allout-mode keybinding variables, `allout-command-prefix', (allout-institute-keymap map))) ;;;_ > allout-institute-keymap (map) (defun allout-institute-keymap (map) - "Associate allout-mode bindings with allout as a minor mode." + "Associate `allout-mode' bindings with allout as a minor mode." ;; Architecture: ;; allout-mode-map var is a keymap by virtue of being a defalias for ;; allout-mode-map-value, which has the actual keymap value. @@ -358,7 +358,7 @@ Examples: See `allout-expose-topic' for more about the exposure process. Also, allout's mode-specific provisions will make topic prefixes default -to the comment-start string, if any, of the language of the file. This +to the `comment-start' string, if any, of the language of the file. This is modulo the setting of `allout-use-mode-specific-leader', which see." :type 'allout-layout-type :group 'allout) @@ -429,8 +429,7 @@ those that do not have the variable `comment-start' set. A value of ;;;_ = allout-show-bodies (defcustom allout-show-bodies nil - "If non-nil, show entire body when exposing a topic, rather than -just the header." + "If non-nil, show entire body when exposing a topic, rather than just the header." :type 'boolean :group 'allout) (make-variable-buffer-local 'allout-show-bodies) @@ -596,16 +595,16 @@ strings." "When non-nil, use mode-specific topic-header prefixes. Allout outline mode will use the mode-specific `allout-mode-leaders' or -comment-start string, if any, to lead the topic prefix string, so topic +`comment-start' string, if any, to lead the topic prefix string, so topic headers look like comments in the programming language. It will also use -the comment-start string, with an `_' appended, for `allout-primary-bullet'. +the `comment-start' string, with an `_' appended, for `allout-primary-bullet'. String values are used as literals, not regular expressions, so do not escape any regular-expression characters. Value t means to first check for assoc value in `allout-mode-leaders' -alist, then use comment-start string, if any, then use default (`.'). -\(See note about use of comment-start strings, below.) +alist, then use `comment-start' string, if any, then use default (`.'). +\(See note about use of `comment-start' strings, below.) Set to the symbol for either of `allout-mode-leaders' or `comment-start' to use only one of them, respectively. @@ -613,9 +612,9 @@ Set to the symbol for either of `allout-mode-leaders' or Value nil means to always use the default (`.') and leave `allout-primary-bullet' unaltered. -comment-start strings that do not end in spaces are tripled in +`comment-start' strings that do not end in spaces are tripled in the header-prefix, and an `_' underscore is tacked on the end, to -distinguish them from regular comment strings. comment-start +distinguish them from regular comment strings. `comment-start' strings that do end in spaces are not tripled, but an underscore is substituted for the space. [This presumes that the space is for appearance, not comment syntax. You can use @@ -633,8 +632,8 @@ undesired.]" (defvar allout-mode-leaders '() "Specific allout-prefix leading strings per major modes. -Use this if the mode's comment-start string isn't what you -prefer, or if the mode lacks a comment-start string. See +Use this if the mode's `comment-start' string isn't what you +prefer, or if the mode lacks a `comment-start' string. See `allout-use-mode-specific-leader' for more details. If you're constructing a string that will comment-out outline @@ -860,7 +859,7 @@ For details, see `allout-toggle-current-subtree-encryption's docstring." ;;;_ : Version ;;;_ = allout-version (defvar allout-version "2.3" - "Version of currently loaded outline package. (allout.el)") + "Version of currently loaded allout.el package.") ;;;_ > allout-version (defun allout-version (&optional here) "Return string describing the loaded outline version." @@ -1509,7 +1508,7 @@ See `allout-encryption-ciphertext-rejection-regexps' for rejection reasons.") 'allout-mode) ;;;_ > allout-write-contents-hook-handler () (defun allout-write-contents-hook-handler () - "Implement `allout-encrypt-unencrypted-on-saves' for file writes + "Implement `allout-encrypt-unencrypted-on-saves' for file writes. Return nil if all goes smoothly, or else return an informative message if an error is encountered. The message will serve as a @@ -3998,8 +3997,7 @@ With repeat count, shift topic depth by that amount." index do-successors sans-offspring) - "Like `allout-rebullet-topic', but on nearest containing topic -\(visible or not). + "Like `allout-rebullet-topic', but on nearest containing topic (visible or not). See `allout-rebullet-heading' for rebulleting behavior. @@ -5056,8 +5054,7 @@ Examples: max-pos))) ;;;_ > allout-old-expose-topic (spec &rest followers) (defun allout-old-expose-topic (spec &rest followers) - "Deprecated. Use `allout-expose-topic' (with different schema -format) instead. + "Deprecated. Use `allout-expose-topic' (with different schema format) instead. Dictate wholesale exposure scheme for current topic, according to SPEC. diff --git a/lisp/ansi-color.el b/lisp/ansi-color.el index 79b1c9912f5..4315a7f3cef 100644 --- a/lisp/ansi-color.el +++ b/lisp/ansi-color.el @@ -604,7 +604,7 @@ codes. Finally, the so changed list of codes is returned." codes)) (defun ansi-color-make-color-map () - "Creates a vector of face definitions and returns it. + "Create a vector of face definitions and return it. The index into the vector is an ANSI code. See the documentation of `ansi-color-map' for an example. diff --git a/lisp/apropos.el b/lisp/apropos.el index 513175d7513..fc15cd3e011 100644 --- a/lisp/apropos.el +++ b/lisp/apropos.el @@ -1305,7 +1305,7 @@ as a heading." (error "There is nothing to follow here")))) (defun apropos-next-symbol () - "Move cursor down to the next symbol in an apropos-mode buffer." + "Move cursor down to the next symbol in an `apropos-mode' buffer." (interactive) (forward-line) (while (and (not (eq (face-at-point) 'apropos-symbol)) @@ -1313,7 +1313,7 @@ as a heading." (forward-line))) (defun apropos-previous-symbol () - "Move cursor back to the last symbol in an apropos-mode buffer." + "Move cursor back to the last symbol in an `apropos-mode' buffer." (interactive) (forward-line -1) (while (and (not (eq (face-at-point) 'apropos-symbol)) diff --git a/lisp/auth-source.el b/lisp/auth-source.el index d938522c803..3c1a6feaeeb 100644 --- a/lisp/auth-source.el +++ b/lisp/auth-source.el @@ -176,7 +176,7 @@ Overrides `password-cache-expiry' through a let-binding." ;; TODO: or maybe leave as (setq auth-source-netrc-use-gpg-tokens 'never) (defcustom auth-source-netrc-use-gpg-tokens 'never - "Set this to tell auth-source when to create GPG password + "Set this to tell `auth-source' when to create GPG password tokens in netrc files. It's either an alist or `never'. Note that if EPA/EPG is not available, this should NOT be used." :version "23.2" ;; No Gnus @@ -503,7 +503,7 @@ soon as a function returns non-nil.") (add-hook 'auth-source-backend-parser-functions #'auth-source-backends-parser-secrets) (defun auth-source-backend-parse-parameters (entry backend) - "Fill in the extra auth-source-backend parameters of ENTRY. + "Fill in the extra `auth-source-backend' parameters of ENTRY. Using the plist ENTRY, get the :host, :port, and :user search parameters." (let ((entry (if (stringp entry) @@ -1227,7 +1227,7 @@ FILE is the file from which we obtained this token." &key backend require create type max host user port &allow-other-keys) - "Given a property list SPEC, return search matches from the :backend. + "Given a property list SPEC, return search matches from the `:backend'. See `auth-source-search' for details on SPEC." ;; just in case, check that the type is correct (null or same as the backend) (cl-assert (or (null type) (eq type (oref backend type))) @@ -2274,7 +2274,7 @@ entries for git.gnus.org: &key backend require type max host user port &allow-other-keys) - "Given a property list SPEC, return search matches from the :backend. + "Given a property list SPEC, return search matches from the `:backend'. See `auth-source-search' for details on SPEC." ;; just in case, check that the type is correct (null or same as the backend) (cl-assert (or (null type) (eq type (oref backend type))) diff --git a/lisp/autoinsert.el b/lisp/autoinsert.el index 995d9e2e0fe..063d0a14d63 100644 --- a/lisp/autoinsert.el +++ b/lisp/autoinsert.el @@ -83,10 +83,11 @@ When this is `function', only ask when called non-interactively." (const :tag "Ask if called non-interactively" function) (other :tag "Ask" t))) -(defcustom auto-insert-prompt "Perform %s auto-insertion? " - "Prompt to use when querying whether to auto-insert. +(defcustom auto-insert-prompt "Perform %s auto-insertion?" + "Prompt to use when querying whether to `auto-insert'. If this contains a %s, that will be replaced by the matching rule." - :type 'string) + :type 'string + :version "28.1") (defcustom auto-insert-alist diff --git a/lisp/bindings.el b/lisp/bindings.el index 5c1adef9b50..343f1ba0fa7 100644 --- a/lisp/bindings.el +++ b/lisp/bindings.el @@ -184,8 +184,8 @@ mouse-3: Remove current window from display")) (defvar mode-line-front-space '(:eval (if (display-graphic-p) " " "-")) "Mode line construct to put at the front of the mode line. By default, this construct is displayed right at the beginning of -the mode line, except that if there is a memory-full message, it -is displayed first.") +the mode line, except that if there is a \"memory full\" message, +it is displayed first.") (put 'mode-line-front-space 'risky-local-variable t) (defun mode-line-mule-info-help-echo (window _object _point) @@ -1086,7 +1086,7 @@ if `inhibit-field-text-motion' is non-nil." (define-key map "p" 'previous-error) (define-key map "\M-p" 'previous-error) map) - "Keymap to repeat next-error key sequences. Used in `repeat-mode'.") + "Keymap to repeat `next-error' key sequences. Used in `repeat-mode'.") (put 'next-error 'repeat-map 'next-error-repeat-map) (put 'previous-error 'repeat-map 'next-error-repeat-map) diff --git a/lisp/bookmark.el b/lisp/bookmark.el index ac63c8f1b0a..d64966df5af 100644 --- a/lisp/bookmark.el +++ b/lisp/bookmark.el @@ -905,7 +905,9 @@ others are still there, should the user decide to delete the most recent one. To yank words from the text of the buffer and use them as part of the -bookmark name, type C-w while setting a bookmark. Successive C-w's +bookmark name, type \\\ +\\[bookmark-yank-word] while setting a bookmark. Successive \ +\\[bookmark-yank-word]'s yank successive words. Typing \\[universal-argument] inserts (at the bookmark name prompt) the name of the last @@ -938,7 +940,9 @@ Otherwise, if a bookmark named NAME already exists but PUSH-BOOKMARK is nil, raise an error. To yank words from the text of the buffer and use them as part of the -bookmark name, type C-w while setting a bookmark. Successive C-w's +bookmark name, type \\\ +\\[bookmark-yank-word] while setting a bookmark. Successive \ +\\[bookmark-yank-word]'s yank successive words. Typing \\[universal-argument] inserts (at the bookmark name prompt) the name of the last @@ -1361,7 +1365,8 @@ If called from Lisp, prompt for NEW-NAME if only OLD-NAME was passed as an argument. If called with two strings, then no prompting is done. You must pass at least OLD-NAME when calling from Lisp. -While you are entering the new name, consecutive C-w's insert +While you are entering the new name, consecutive \ +\\\\[bookmark-yank-word]'s insert consecutive words from the text of the buffer into the new bookmark name." (interactive (list (bookmark-completing-read "Old bookmark name"))) @@ -1734,8 +1739,8 @@ unique numeric suffixes \"<2>\", \"<3>\", etc." (define-key map [mouse-2] 'bookmark-bmenu-other-window-with-mouse) map)) -(easy-menu-define - bookmark-menu bookmark-bmenu-mode-map "Bookmark Menu" +(easy-menu-define bookmark-menu bookmark-bmenu-mode-map + "Menu for `bookmark-bmenu'." '("Bookmark" ["Select Bookmark in This Window" bookmark-bmenu-this-window t] ["Select Bookmark in Full-Frame Window" bookmark-bmenu-1-window t] @@ -2062,7 +2067,7 @@ You can mark bookmarks with the \\\\[bookmark-bmenu-mar (defun bookmark-bmenu-save () "Save the current list into a bookmark file. -With a prefix arg, prompts for a file to save them in. +With a prefix arg, prompt for a file to save them in. See also the related behaviors of `bookmark-load' and `bookmark-bmenu-load'." diff --git a/lisp/buff-menu.el b/lisp/buff-menu.el index 340c926f8d6..1013a7c4973 100644 --- a/lisp/buff-menu.el +++ b/lisp/buff-menu.el @@ -222,7 +222,7 @@ In Buffer Menu mode, the following commands are defined: so the Buffer Menu remains visible in its window. \\[Buffer-menu-view] Select current line's buffer, in View mode. \\[Buffer-menu-view-other-window] Select that buffer in - another window, in view-mode. + another window, in `view-mode'. \\[Buffer-menu-switch-other-window] Make another window display that buffer. \\[Buffer-menu-mark] Mark current line's buffer to be displayed. \\[Buffer-menu-select] Select current line's buffer. @@ -233,7 +233,7 @@ In Buffer Menu mode, the following commands are defined: \\[Buffer-menu-isearch-buffers] Incremental search in the marked buffers. \\[Buffer-menu-isearch-buffers-regexp] Isearch for regexp in the marked buffers. \\[Buffer-menu-multi-occur] Show lines matching regexp in the marked buffers. -\\[Buffer-menu-visit-tags-table] visit-tags-table this buffer. +\\[Buffer-menu-visit-tags-table] `visit-tags-table' this buffer. \\[Buffer-menu-not-modified] Clear modified-flag on that buffer. \\[Buffer-menu-save] Mark that buffer to be saved, and move down. \\[Buffer-menu-delete] Mark that buffer to be deleted, and move down. @@ -306,7 +306,7 @@ ARG, show only buffers that are visiting files." (display-buffer (list-buffers-noselect arg))) (defun Buffer-menu-toggle-files-only (arg) - "Toggle whether the current buffer-menu displays only file buffers. + "Toggle whether the current `buffer-menu' displays only file buffers. With a positive ARG, display only file buffers. With zero or negative ARG, display other buffers as well." (interactive "P" Buffer-menu-mode) diff --git a/lisp/button.el b/lisp/button.el index 74dfb5d5419..aedd07b762d 100644 --- a/lisp/button.el +++ b/lisp/button.el @@ -113,21 +113,22 @@ Mode-specific keymaps may want to use this as their parent keymap.") ;; [this is an internal function] (defsubst button-category-symbol (type) - "Return the symbol used by button-type TYPE to store properties. + "Return the symbol used by `button-type' TYPE to store properties. Buttons inherit them by setting their `category' property to that symbol." (or (get type 'button-category-symbol) (error "Unknown button type `%s'" type))) (defun define-button-type (name &rest properties) "Define a `button type' called NAME (a symbol). -The remaining arguments form a plist of PROPERTY VALUE pairs, -specifying properties to use as defaults for buttons with this type -\(a button's type may be set by giving it a `type' property when -creating the button, using the :type keyword argument). +The remaining PROPERTIES arguments form a plist of PROPERTY VALUE +pairs, specifying properties to use as defaults for buttons with +this type (a button's type may be set by giving it a `type' +property when creating the button, using the :type keyword +argument). In addition, the keyword argument :supertype may be used to specify a -button-type from which NAME inherits its default property values -\(however, the inheritance happens only when NAME is defined; subsequent +`button-type' from which NAME inherits its default property values +(however, the inheritance happens only when NAME is defined; subsequent changes to a supertype are not reflected in its subtypes)." (let ((catsym (make-symbol (concat (symbol-name name) "-button"))) (super-catsym @@ -156,15 +157,15 @@ changes to a supertype are not reflected in its subtypes)." name)) (defun button-type-put (type prop val) - "Set the button-type TYPE's PROP property to VAL." + "Set the `button-type' TYPE's PROP property to VAL." (put (button-category-symbol type) prop val)) (defun button-type-get (type prop) - "Get the property of button-type TYPE named PROP." + "Get the property of `button-type' TYPE named PROP." (get (button-category-symbol type) prop)) (defun button-type-subtype-p (type supertype) - "Return non-nil if button-type TYPE is a subtype of SUPERTYPE." + "Return non-nil if `button-type' TYPE is a subtype of SUPERTYPE." (or (eq type supertype) (and type (button-type-subtype-p (button-type-get type 'supertype) @@ -271,11 +272,11 @@ This function only works when BUTTON is in the current buffer." (button-end button)))) (defsubst button-type (button) - "Return BUTTON's button-type." + "Return BUTTON's `button-type'." (button-get button 'type)) (defun button-has-type-p (button type) - "Return non-nil if BUTTON has button-type TYPE, or one of its subtypes." + "Return non-nil if BUTTON has `button-type' TYPE, or one of its subtypes." (button-type-subtype-p (button-get button 'type) type)) (defun button--area-button-p (b) @@ -290,10 +291,10 @@ Such area buttons are used for buttons in the mode-line and header-line." (defun make-button (beg end &rest properties) "Make a button from BEG to END in the current buffer. -The remaining arguments form a plist of PROPERTY VALUE pairs, -specifying properties to add to the button. +The remaining PROPERTIES arguments form a plist of PROPERTY VALUE +pairs, specifying properties to add to the button. In addition, the keyword argument :type may be used to specify a -button-type from which to inherit other properties; see +`button-type' from which to inherit other properties; see `define-button-type'. Also see `make-text-button', `insert-button'." @@ -314,7 +315,7 @@ Also see `make-text-button', `insert-button'." The remaining arguments form a plist of PROPERTY VALUE pairs, specifying properties to add to the button. In addition, the keyword argument :type may be used to specify a -button-type from which to inherit other properties; see +`button-type' from which to inherit other properties; see `define-button-type'. Also see `insert-text-button', `make-button'." @@ -328,10 +329,10 @@ Also see `insert-text-button', `make-button'." (defun make-text-button (beg end &rest properties) "Make a button from BEG to END in the current buffer. -The remaining arguments form a plist of PROPERTY VALUE pairs, -specifying properties to add to the button. +The remaining PROPERTIES arguments form a plist of PROPERTY VALUE +pairs, specifying properties to add to the button. In addition, the keyword argument :type may be used to specify a -button-type from which to inherit other properties; see +`button-type' from which to inherit other properties; see `define-button-type'. This function is like `make-button', except that the button is actually @@ -382,10 +383,10 @@ Also see `insert-text-button'." (defun insert-text-button (label &rest properties) "Insert a button with the label LABEL. -The remaining arguments form a plist of PROPERTY VALUE pairs, -specifying properties to add to the button. +The remaining PROPERTIES arguments form a plist of PROPERTY VALUE +pairs, specifying properties to add to the button. In addition, the keyword argument :type may be used to specify a -button-type from which to inherit other properties; see +`button-type' from which to inherit other properties; see `define-button-type'. This function is like `insert-button', except that the button is diff --git a/lisp/calc/calc-aent.el b/lisp/calc/calc-aent.el index 0e913ddfdb9..52c024865a7 100644 --- a/lisp/calc/calc-aent.el +++ b/lisp/calc/calc-aent.el @@ -537,8 +537,7 @@ The value t means abort and give an error message.") ("₋" "-") ; - ("₍" "(") ; ( ("₎" ")")) ; ) - "A list whose elements (old new) indicate replacements to make -in Calc algebraic input.") + "A list indicating replacements to make in Calc algebraic input.") (defvar math-read-superscripts "⁰¹²³⁴⁵⁶⁷⁸⁹⁺⁻⁽⁾ⁿⁱ" ; 0123456789+-()ni diff --git a/lisp/calc/calc-forms.el b/lisp/calc/calc-forms.el index ac57011da04..ce8e3579f48 100644 --- a/lisp/calc/calc-forms.el +++ b/lisp/calc/calc-forms.el @@ -703,16 +703,19 @@ in the Gregorian calendar." fmt)))) (defconst math-julian-date-beginning '(float 17214245 -1) - "The beginning of the Julian date calendar, -as measured in the number of days before December 31, 1 BC (Gregorian).") + "The beginning of the Julian date calendar. +This is measured in the number of days before December 31, 1 +BC (Gregorian).") (defconst math-julian-date-beginning-int 1721425 - "The beginning of the Julian date calendar, -as measured in the integer number of days before December 31, 1 BC (Gregorian).") + "The beginning of the Julian date calendar. +This is measured in the integer number of days before December +31, 1 BC (Gregorian).") (defconst math-unix-epoch 719163 - "The beginning of Unix time: days from December 31, 1 BC (Gregorian) -to Jan 1, 1970 AD.") + "The beginning of Unix time. +This is measured in the integer number of days from December 31, +1 BC (Gregorian) to Jan 1, 1970 AD.") (defun math-format-date-part (x) (cond ((stringp x) diff --git a/lisp/calc/calc-poly.el b/lisp/calc/calc-poly.el index 77587cc4b86..5d74a8f106b 100644 --- a/lisp/calc/calc-poly.el +++ b/lisp/calc/calc-poly.el @@ -454,7 +454,7 @@ This returns only the remainder from the pseudo-division." (defun math-atomic-factorp (expr) - "Return true if is a factor containing no sums or quotients." + "Return non-nil if is a factor containing no sums or quotients." (cond ((eq (car-safe expr) '*) (and (math-atomic-factorp (nth 1 expr)) (math-atomic-factorp (nth 2 expr)))) diff --git a/lisp/calc/calc.el b/lisp/calc/calc.el index afb43c0f338..45a4d56a371 100644 --- a/lisp/calc/calc.el +++ b/lisp/calc/calc.el @@ -400,8 +400,7 @@ This is not required to be present for user-written mode annotations." :type 'boolean) (defcustom calc-ensure-consistent-units nil - "If non-nil, make sure new units are consistent with current units -when converting units." + "If non-nil, ensure new units are consistent with current units when converting." :version "24.3" :type 'boolean) @@ -468,11 +467,11 @@ This is 1 unless `calc-truncate-stack' has been used.") (defvar calc-display-sci-high 0 "Floating-point numbers with this positive exponent or higher above the -current precision are displayed in scientific notation in calc-mode.") +current precision are displayed in scientific notation in `calc-mode'.") (defvar calc-display-sci-low -3 "Floating-point numbers with this negative exponent or lower are displayed -scientific notation in calc-mode.") +scientific notation in `calc-mode'.") (defvar calc-digit-after-point nil "If t, display at least one digit after the decimal point, as in `12.0'. @@ -493,8 +492,7 @@ This setting only applies to floats in normal display mode.") "List of variables used in customizing GNU Calc.") (defmacro defcalcmodevar (var defval &optional doc) - "Declare VAR as a Calc variable, with default value DEFVAL -and doc-string DOC. + "Declare VAR as a Calc variable, with default value DEFVAL and doc-string DOC. The variable VAR will be added to `calc-mode-var-list'." `(progn (defvar ,var ,defval ,doc) @@ -912,7 +910,7 @@ Used by `calc-user-invocation'.") (defvar calc-trail-pointer nil "The \"current\" entry in trail buffer.") (defvar calc-trail-overlay nil - "The value of overlay-arrow-string.") + "The value of `overlay-arrow-string'.") (defvar calc-undo-list nil "The list of previous operations for undo.") (defvar calc-redo-list nil diff --git a/lisp/calculator.el b/lisp/calculator.el index 415e0b4c77c..6bcea2d885e 100644 --- a/lisp/calculator.el +++ b/lisp/calculator.el @@ -833,8 +833,7 @@ The result should not exceed the screen width." (concat prompt (if (<= trim 0) expr (substring expr trim))))) (defun calculator-string-to-number (str) - "Convert the given STR to a number, according to the value of -`calculator-input-radix'." + "Convert STR to number according to `calculator-input-radix'." (if calculator-input-radix (string-to-number str (cadr (assq calculator-input-radix '((bin 2) (oct 8) (hex 16))))) @@ -1171,9 +1170,9 @@ arguments." ;;; Input interaction (defun calculator-last-input (&optional keys) - "Return the last key sequence that was used to invoke this command, or -the input KEYS. Uses the `function-key-map' translate keypad numbers to -plain ones." + "Return the last key sequence used to invoke this command, or the input KEYS. +Uses the `function-key-map' translate keypad numbers to plain +ones." (let* ((inp (or keys (this-command-keys))) (inp (or (and (arrayp inp) (not (stringp inp)) (lookup-key function-key-map inp)) diff --git a/lisp/calendar/diary-lib.el b/lisp/calendar/diary-lib.el index 9ca7ce3f003..2eb7977a164 100644 --- a/lisp/calendar/diary-lib.el +++ b/lisp/calendar/diary-lib.el @@ -1223,8 +1223,7 @@ ensure that all relevant variables are set. \(diary-mail-entries) -# diary-rem.el ends here -" +# diary-rem.el ends here" (interactive "P") (if (string-equal diary-mail-addr "") (user-error "You must set `diary-mail-addr' to use this command") @@ -1254,10 +1253,10 @@ the regexp with parentheses." paren)) (defvar diary-marking-entries-flag nil - "True during the marking of diary entries, nil otherwise.") + "Non-nil during the marking of diary entries, nil otherwise.") (defvar diary-marking-entry-flag nil - "True during the marking of diary entries, if current entry is marking.") + "Non-nil during the marking of diary entries, if current entry is marking.") ;; file-glob-attrs bound in diary-mark-entries. (defun diary-mark-entries-1 (markfunc &optional months symbol absfunc) diff --git a/lisp/char-fold.el b/lisp/char-fold.el index 46a3f93d0af..e3ab7d5b64c 100644 --- a/lisp/char-fold.el +++ b/lisp/char-fold.el @@ -20,6 +20,8 @@ ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs. If not, see . +;;; Commentary: + ;;; Code: (eval-and-compile diff --git a/lisp/cmuscheme.el b/lisp/cmuscheme.el index 0910ea6187e..e197069d6b8 100644 --- a/lisp/cmuscheme.el +++ b/lisp/cmuscheme.el @@ -186,7 +186,7 @@ Return before the end of the process' output copies the sexp ending at point Delete converts tabs to spaces as it moves back. Tab indents for Scheme; with argument, shifts rest of expression rigidly with the current line. -C-M-q does Tab on each line starting within following expression. +\\[indent-pp-sexp] does Tab on each line starting within following expression. Paragraphs are separated only by blank lines. Semicolons start comments. If you accidentally suspend your process, use \\[comint-continue-subjob] to continue it." diff --git a/lisp/comint.el b/lisp/comint.el index 56d4420e609..8bf23897f9e 100644 --- a/lisp/comint.el +++ b/lisp/comint.el @@ -2830,7 +2830,7 @@ if necessary." (when (>= count 0) (comint-update-fence)))) (defun comint-kill-region (beg end) - "Like `kill-region', but ignores read-only properties, if safe. + "Like `kill-region', but ignore read-only properties, if safe. This command assumes that the buffer contains read-only \"prompts\" which are regions with front-sticky read-only properties at the beginning of a line, with the preceding newline diff --git a/lisp/cus-edit.el b/lisp/cus-edit.el index 7eae2e416bb..69baf17f5ee 100644 --- a/lisp/cus-edit.el +++ b/lisp/cus-edit.el @@ -5123,8 +5123,8 @@ If several parents are listed, go to the first of them." The following commands are available: \\\ -Move to next button, link or editable field. \\[widget-forward] -Move to previous button, link or editable field. \\[widget-backward] +Move to next button, link or editable field. \\[widget-forward] +Move to previous button, link or editable field. \\[widget-backward] \\\ Complete content of editable text field. \\[widget-complete] \\\ diff --git a/lisp/cus-theme.el b/lisp/cus-theme.el index 7457d9e3236..07881e9b74e 100644 --- a/lisp/cus-theme.el +++ b/lisp/cus-theme.el @@ -22,6 +22,8 @@ ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs. If not, see . +;;; Commentary: + ;;; Code: (require 'widget) diff --git a/lisp/dabbrev.el b/lisp/dabbrev.el index e113cc94c33..037787797bb 100644 --- a/lisp/dabbrev.el +++ b/lisp/dabbrev.el @@ -568,8 +568,7 @@ See also `dabbrev-abbrev-char-regexp' and \\[dabbrev-completion]." major-mode))) (defun dabbrev--goto-start-of-abbrev () - "Back over all abbrev type characters and then moves forward over -all skip characters." + "Back over all abbrev type characters then move forward over all skip characters." ;; Move backwards over abbrev chars (save-match-data (when (> (point) (minibuffer-prompt-end)) diff --git a/lisp/dired-aux.el b/lisp/dired-aux.el index 4549f45ef67..1bb5b929353 100644 --- a/lisp/dired-aux.el +++ b/lisp/dired-aux.el @@ -1326,7 +1326,7 @@ Return nil if no change in files." (user-error "No compression rule found for \ `dired-compress-directory-default-suffix' %s, see `dired-compress-files-alist' for\ - the supported suffixes list." + the supported suffixes list" dired-compress-directory-default-suffix))) (let* ((suffix (or dired-compress-file-default-suffix ".gz")) (out-name (concat file suffix)) @@ -1335,7 +1335,7 @@ Return nil if no change in files." dired-compress-file-alist))) (if (not rule) (user-error "No compression rule found for suffix %s, \ -see `dired-compress-file-alist' for the supported suffixes list." +see `dired-compress-file-alist' for the supported suffixes list" dired-compress-file-default-suffix) (and (file-exists-p file) (or (not (file-exists-p out-name)) diff --git a/lisp/dired-x.el b/lisp/dired-x.el index 9f9f1701730..cf257c8169d 100644 --- a/lisp/dired-x.el +++ b/lisp/dired-x.el @@ -589,7 +589,7 @@ This is useful if you want to peruse and move around in an ls -lR output file, for example one you got from an ftp server. With ange-ftp, you can even Dired a directory containing an ls-lR file, visit that file and turn on Virtual Dired mode. But don't try to save -this file, as dired-virtual indents the listing and thus changes the +this file, as `dired-virtual' indents the listing and thus changes the buffer. If you have saved a Dired buffer in a file you can use \\[dired-virtual] to @@ -956,7 +956,7 @@ as the variable `file'. If several COMMANDs are given, the first one will be the default and the rest will be added temporarily to the history and can be retrieved -with \\[previous-history-element] (M-p) . +with `previous-history-element' (\\\\[previous-history-element]). The variable `dired-guess-shell-case-fold-search' controls whether REGEXP is matched case-sensitively." diff --git a/lisp/dired.el b/lisp/dired.el index 266a03e6cc3..07c13e18b95 100644 --- a/lisp/dired.el +++ b/lisp/dired.el @@ -2219,8 +2219,7 @@ Do so according to the former subdir alist OLD-SUBDIR-ALIST." ;; Autoload cookie needed by desktop.el ;;;###autoload (defun dired-mode (&optional dirname switches) - "\ -Mode for \"editing\" directory listings. + "Mode for \"editing\" directory listings. In Dired, you are \"editing\" a list of the files in a directory and (optionally) its subdirectories, in the format of `ls -lR'. Each directory is a page: use \\[backward-page] and \\[forward-page] to move pagewise. @@ -3697,7 +3696,7 @@ no ARGth marked file is found before this line." (defun dired-mark-files-in-region (start end) (let ((inhibit-read-only t)) (if (> start end) - (error "start > end")) + (error "Start > End")) (goto-char start) ; assumed at beginning of line (while (< (point) end) ;; Skip subdir line and following garbage like the `total' line: diff --git a/lisp/display-fill-column-indicator.el b/lisp/display-fill-column-indicator.el index 50252af4533..7e9d62c5d1a 100644 --- a/lisp/display-fill-column-indicator.el +++ b/lisp/display-fill-column-indicator.el @@ -45,7 +45,7 @@ ;;;###autoload (define-minor-mode display-fill-column-indicator-mode - "Toggle display of fill-column indicator. + "Toggle display of `fill-column' indicator. This uses `display-fill-column-indicator' internally. To change the position of the column displayed by default diff --git a/lisp/dos-vars.el b/lisp/dos-vars.el index 2f7b3760e3f..7fcbb56d224 100644 --- a/lisp/dos-vars.el +++ b/lisp/dos-vars.el @@ -34,9 +34,9 @@ :type '(repeat string)) (defcustom dos-codepage-setup-hook nil - "List of functions to be called after the DOS terminal and coding -systems are set up. This is the place, e.g., to set specific entries -in `standard-display-table' as appropriate for your codepage, if + "List of functions to call after setting up DOS terminal and coding systems. +This is the place, e.g., to set specific entries in +`standard-display-table' as appropriate for your codepage, if `IT-display-table-setup' doesn't do a perfect job." :type '(hook) :version "20.3.3") diff --git a/lisp/edmacro.el b/lisp/edmacro.el index 8ee413acd06..e90b3a006ef 100644 --- a/lisp/edmacro.el +++ b/lisp/edmacro.el @@ -108,7 +108,7 @@ With a prefix argument, format the macro in a more concise way." (memq cmd-noremap '(call-last-kbd-macro kmacro-call-macro kmacro-end-or-call-macro kmacro-end-and-call-macro)) (member keys '("\r" [return]))) (or last-kbd-macro - (y-or-n-p "No keyboard macro defined. Create one? ") + (y-or-n-p "No keyboard macro defined. Create one?") (keyboard-quit)) (setq mac (or last-kbd-macro "")) (setq keys nil) @@ -244,8 +244,9 @@ or nil, use a compact 80-column format." (and (fboundp cmd) (not (arrayp (symbol-function cmd))) (not (get cmd 'kmacro)) (not (y-or-n-p - (format "Command %s is already defined; %s" - cmd "proceed? "))) + (format + "Command %s is already defined; proceed?" + cmd))) (keyboard-quit)))) t) ((looking-at "Key:\\(.*\\)$") @@ -264,9 +265,9 @@ or nil, use a compact 80-column format." (not (or (arrayp (symbol-function b)) (get b 'kmacro)))) (not (y-or-n-p - (format "Key %s is already defined; %s" - (edmacro-format-keys key 1) - "proceed? "))) + (format + "Key %s is already defined; proceed?" + (edmacro-format-keys key 1)))) (keyboard-quit)))))) t) ((looking-at "Counter:[ \t]*\\([^ \t\n]*\\)[ \t]*$") diff --git a/lisp/elec-pair.el b/lisp/elec-pair.el index 45bc270db6a..ba88c819133 100644 --- a/lisp/elec-pair.el +++ b/lisp/elec-pair.el @@ -63,7 +63,7 @@ When inserting a closing paren character right before the same character, just skip that character instead, so that hitting ( followed by ) results in \"()\" rather than \"())\". -This can be convenient for people who find it easier to hit ) than C-f. +This can be convenient for people who find it easier to hit ) than \\[forward-char]. Can also be a function of one argument (the closer char just inserted), in which case that function's return value is diff --git a/lisp/epa-dired.el b/lisp/epa-dired.el index 8a4f8933bf8..18f3f055745 100644 --- a/lisp/epa-dired.el +++ b/lisp/epa-dired.el @@ -21,6 +21,8 @@ ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs. If not, see . +;;; Commentary: + ;;; Code: (require 'epa) diff --git a/lisp/epa-file.el b/lisp/epa-file.el index 33bf5adabe6..fe187589aa7 100644 --- a/lisp/epa-file.el +++ b/lisp/epa-file.el @@ -21,8 +21,9 @@ ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs. If not, see . +;;; Commentary: + ;;; Code: -;;; Dependencies (require 'epa) (require 'epa-hook) diff --git a/lisp/epa-hook.el b/lisp/epa-hook.el index 99a432c236e..aa196851d4d 100644 --- a/lisp/epa-hook.el +++ b/lisp/epa-hook.el @@ -21,6 +21,8 @@ ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs. If not, see . +;;; Commentary: + ;;; Code: (defgroup epa-file nil diff --git a/lisp/epa-mail.el b/lisp/epa-mail.el index b9dd437ed12..9b3aa0c7fd3 100644 --- a/lisp/epa-mail.el +++ b/lisp/epa-mail.el @@ -21,8 +21,9 @@ ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs. If not, see . +;;; Commentary: + ;;; Code: -;;; Dependencies (require 'epa) (require 'mail-utils) diff --git a/lisp/epa.el b/lisp/epa.el index ed1dae3e8ae..57d355cb3e0 100644 --- a/lisp/epa.el +++ b/lisp/epa.el @@ -20,8 +20,9 @@ ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs. If not, see . +;;; Commentary: + ;;; Code: -;;; Dependencies (require 'epg) (eval-when-compile (require 'subr-x)) @@ -461,7 +462,7 @@ q trust status questionable. - trust status unspecified. ;;;###autoload (defun epa-select-keys (context prompt &optional names secret) "Display a user's keyring and ask him to select keys. -CONTEXT is an epg-context. +CONTEXT is an `epg-context'. PROMPT is a string to prompt with. NAMES is a list of strings to be matched with keys. If it is nil, all the keys are listed. @@ -968,8 +969,7 @@ For example: ;;;###autoload (defun epa-verify-cleartext-in-region (start end) - "Verify OpenPGP cleartext signed messages in the current region -between START and END. + "Verify OpenPGP cleartext signed messages in current region from START to END. Don't use this command in Lisp programs! See the reason described in the `epa-verify-region' documentation." @@ -1202,8 +1202,7 @@ If no one is selected, symmetric encryption will be performed. ") ;;;###autoload (defun epa-import-armor-in-region (start end) - "Import keys in the OpenPGP armor format in the current region -between START and END." + "Import keys in the OpenPGP armor format in the current region from START to END." (interactive "r") (save-excursion (save-restriction diff --git a/lisp/epg.el b/lisp/epg.el index 1d37cbcfb57..ea7aa869a0f 100644 --- a/lisp/epg.el +++ b/lisp/epg.el @@ -21,6 +21,8 @@ ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs. If not, see . +;;; Commentary: + ;;; Code: ;;; Prelude @@ -804,7 +806,7 @@ callback data (if any)." (when (and epg-key-id (string-match "\\`passphrase\\." string)) (unless (epg-context-passphrase-callback context) - (error "passphrase-callback not set")) + (error "Variable `passphrase-callback' not set")) (let (inhibit-quit passphrase passphrase-with-new-line diff --git a/lisp/face-remap.el b/lisp/face-remap.el index c84742be5a2..50302b9682c 100644 --- a/lisp/face-remap.el +++ b/lisp/face-remap.el @@ -397,7 +397,7 @@ a top-level keymap, `text-scale-increase' or (defcustom buffer-face-mode-face 'variable-pitch "The face specification used by `buffer-face-mode'. It may contain any value suitable for a `face' text property, -including a face name, a list of face names, a face-attribute +including a face name, a list of face names, a face attribute plist, etc." :type '(choice (face) (repeat :tag "List of faces" face) diff --git a/lisp/faces.el b/lisp/faces.el index a5aef757b1d..7b96d938c56 100644 --- a/lisp/faces.el +++ b/lisp/faces.el @@ -1796,8 +1796,8 @@ If FRAME is nil, that stands for the selected frame." (defalias 'x-defined-colors 'defined-colors) (defun defined-colors-with-face-attributes (&optional frame foreground) - "Return a list of colors supported for a particular frame. -See `defined-colors' for arguments and return value. In contrast + "Return a list of colors supported for a particular FRAME. +See `defined-colors' for arguments and return value. In contrast to `defined-colors' the elements of the returned list are color strings with text properties, that make the color names render with the color they represent as background color (if FOREGROUND diff --git a/lisp/ffap.el b/lisp/ffap.el index b6e419b2d67..db380164272 100644 --- a/lisp/ffap.el +++ b/lisp/ffap.el @@ -465,11 +465,11 @@ Returned values: mesg) nil) ((string-match "not responding$" mesg) mesg) ;; v19: - ;; (file-error "connection failed" "permission denied" + ;; (file-error "Connection failed" "permission denied" ;; "nonesuch" "ffap-machine-p") - ;; (file-error "connection failed" "host is unreachable" + ;; (file-error "Connection failed" "host is unreachable" ;; "gopher.house.gov" "ffap-machine-p") - ;; (file-error "connection failed" "address already in use" + ;; (file-error "Connection failed" "address already in use" ;; "ftp.uu.net" "ffap-machine-p") ((equal mesg "connection failed") (if (string= (downcase (nth 2 error)) "permission denied") @@ -1088,8 +1088,8 @@ If a given RFC isn't in these then `ffap-rfc-path' is offered." (latex-mode "--:\\\\$+<>@-Z_[:alpha:]~*?" "<@" "@>;.,!:") (tex-mode "--:\\\\$+<>@-Z_[:alpha:]~*?" "<@" "@>;.,!:") ) - "Alist of (MODE CHARS BEG END), where MODE is a symbol, -possibly a major-mode name, or one of the symbols + "Alist of (MODE CHARS BEG END), where MODE is a symbol. +This is possibly a major-mode name, or one of the symbols `file', `url', `machine', and `nocolon'. Function `ffap-string-at-point' uses the data fields as follows: 1. find a maximal string of CHARS around point, diff --git a/lisp/fileloop.el b/lisp/fileloop.el index 45b9cea9397..cd60600a250 100644 --- a/lisp/fileloop.el +++ b/lisp/fileloop.el @@ -44,6 +44,7 @@ (defcustom fileloop-revert-buffers 'silent "Whether to revert files during fileloop operation. +This can be one of: `silent' means to only do it if `revert-without-query' is applicable; t means to offer to do it for all applicable files; nil means never to do it" diff --git a/lisp/files.el b/lisp/files.el index b113ff32f2f..2f7e936ff61 100644 --- a/lisp/files.el +++ b/lisp/files.el @@ -1584,7 +1584,7 @@ Signals a `file-already-exists' error if a file of the new name already exists unless optional fourth argument OK-IF-ALREADY-EXISTS is non-nil. A number as fourth arg means request confirmation if the new name already exists. This is what happens in interactive -use with M-x." +use with \\[execute-extended-command]." (interactive (let ((default-coding (or file-name-coding-system default-file-name-coding-system)) @@ -2520,7 +2520,7 @@ Do you want to revisit the file normally now? "))) (current-buffer)))) (defun insert-file-contents-literally (filename &optional visit beg end replace) - "Like `insert-file-contents', but only reads in the file literally. + "Like `insert-file-contents', but only read in the file literally. See `insert-file-contents' for an explanation of the parameters. A buffer may be modified in several ways after reading into the buffer, due to Emacs features such as format decoding, character code diff --git a/lisp/filesets.el b/lisp/filesets.el index 63f0e8ba3ff..9182c539452 100644 --- a/lisp/filesets.el +++ b/lisp/filesets.el @@ -112,7 +112,8 @@ (defvar filesets-updated-buffers nil "A list of buffers with updated menu bars.") (defvar filesets-menu-use-cached-flag nil - "Use cached data. See `filesets-menu-ensure-use-cached' for details.") + "Non-nil means use cached data. +See `filesets-menu-ensure-use-cached' for details.") (defvar filesets-update-cache-file-flag nil "Non-nil means the cache needs updating.") (defvar filesets-ignore-next-set-default nil @@ -607,8 +608,8 @@ the filename." (:ignore-on-read-text t) ;; (:constraintp ,pic-cmd) )))) - "Alist of file patterns and external viewers for use with -`filesets-find-or-display-file'. + "Alist of file patterns and external viewers. +This is intended for use with `filesets-find-or-display-file'. Has the form ((FILE-PATTERN VIEWER PROPERTIES) ...), VIEWER being either a function or a command name as string. @@ -1770,7 +1771,7 @@ User will be queried, if no fileset name is provided." filesets-data nil))) (entry (or (assoc name filesets-data) (when (y-or-n-p - (format "Fileset %s does not exist. Create it? " + (format "Fileset %s does not exist. Create it?" name)) (progn (add-to-list 'filesets-data (list name '(:files))) @@ -2198,8 +2199,9 @@ FS is a fileset's name. FLIST is a list returned by nil)) (defun filesets-build-dir-submenu (entry lookup-name dir patt) - "Build a :tree submenu named LOOKUP-NAME with base directory DIR including -all files matching PATT for filesets ENTRY." + "Build a `:tree' submenu named LOOKUP-NAME. +It has base directory DIR including all files matching PATT for +filesets ENTRY." (let ((fd (filesets-entry-get-filter-dirs-flag entry)) (depth (or (filesets-entry-get-tree-max-level entry) filesets-tree-max-level))) diff --git a/lisp/find-dired.el b/lisp/find-dired.el index 87a7407a866..ebdb10ae9fc 100644 --- a/lisp/find-dired.el +++ b/lisp/find-dired.el @@ -266,7 +266,7 @@ it finishes, type \\[kill-find]." ;;;###autoload (defun find-name-dired (dir pattern) - "Search DIR recursively for files matching the globbing pattern PATTERN, + "Search DIR recursively for files matching the globbing PATTERN, and run Dired on those files. PATTERN is a shell wildcard (not an Emacs regexp) and need not be quoted. The default command run (after changing into DIR) is diff --git a/lisp/foldout.el b/lisp/foldout.el index cadf2746ba1..8925241df32 100644 --- a/lisp/foldout.el +++ b/lisp/foldout.el @@ -239,7 +239,7 @@ An end marker of nil means the fold ends after (point-max).") Normally the body and the immediate subheadings are exposed, but optional arg EXPOSURE \(interactively with prefix arg) changes this:- - EXPOSURE > 0 exposes n levels of subheadings (c.f. show-children) + EXPOSURE > 0 exposes n levels of subheadings (c.f. `show-children') EXPOSURE < 0 exposes only the body EXPOSURE = 0 exposes the entire subtree" (interactive "P") diff --git a/lisp/font-core.el b/lisp/font-core.el index db06a607660..95bf46c9b8b 100644 --- a/lisp/font-core.el +++ b/lisp/font-core.el @@ -21,6 +21,8 @@ ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs. If not, see . +;;; Commentary: + ;;; Code: ;; This variable is used by mode packages that support Font Lock mode by diff --git a/lisp/forms.el b/lisp/forms.el index e1de0111336..551a1ba3c97 100644 --- a/lisp/forms.el +++ b/lisp/forms.el @@ -1705,7 +1705,7 @@ As a side effect: re-calculates the number of records in the data file." ;;; Other commands (defun forms-toggle-read-only (arg) - "Toggles read-only mode of a forms mode buffer. + "Toggle read-only mode of a forms mode buffer. With an argument, enables read-only mode if the argument is positive. Otherwise enables edit mode if the visited file is writable." @@ -1878,7 +1878,7 @@ after the current record." (setq forms--search-regexp regexp)) (defun forms-save-buffer (&optional args) - "Forms mode replacement for save-buffer. + "Forms mode replacement for `save-buffer'. It saves the data buffer instead of the forms buffer. Calls `forms-write-file-filter' before, and `forms-read-file-filter' after writing out the data." diff --git a/lisp/hexl.el b/lisp/hexl.el index 4a7bf9479aa..79dd5c40c69 100644 --- a/lisp/hexl.el +++ b/lisp/hexl.el @@ -1165,7 +1165,7 @@ This function is assumed to be used as callback function for `hl-line-mode'." ;; startup stuff. -(easy-menu-define hexl-menu hexl-mode-map "Hexl Mode menu" +(easy-menu-define hexl-menu hexl-mode-map "Hexl Mode menu." '("Hexl" :help "Hexl-specific Features" diff --git a/lisp/hi-lock.el b/lisp/hi-lock.el index 4c924e9d52a..7d126cb558e 100644 --- a/lisp/hi-lock.el +++ b/lisp/hi-lock.el @@ -244,7 +244,7 @@ by cycling through the faces in `hi-lock-face-defaults'." "String used to identify hi-lock patterns at the start of files.") (defvar hi-lock-archaic-interface-message-used nil - "True if user alerted that `global-hi-lock-mode' is now the global switch. + "Non-nil if user alerted that `global-hi-lock-mode' is now the global switch. Earlier versions of hi-lock used `hi-lock-mode' as the global switch; the message is issued if it appears that `hi-lock-mode' is used assuming that older functionality. This variable avoids multiple reminders.") diff --git a/lisp/image-dired.el b/lisp/image-dired.el index b92a9371ec2..3ca47300a99 100644 --- a/lisp/image-dired.el +++ b/lisp/image-dired.el @@ -519,7 +519,7 @@ Used by `image-dired-copy-with-exif-file-name'." (defcustom image-dired-show-all-from-dir-max-files 50 "Maximum number of files to show using `image-dired-show-all-from-dir' -before warning the user." +before warning." :type 'integer) (defmacro image-dired--with-db-file (&rest body) @@ -1958,7 +1958,7 @@ With prefix argument ARG, display image in its original size." (image-dired-display-image (dired-get-filename) arg)) (defun image-dired-image-at-point-p () - "Return true if there is an image-dired thumbnail at point." + "Return non-nil if there is an `image-dired' thumbnail at point." (get-text-property (point) 'image-dired-thumbnail)) (defun image-dired-rotate-thumbnail (degrees) diff --git a/lisp/imenu.el b/lisp/imenu.el index 788755a2d7e..22412d5f88b 100644 --- a/lisp/imenu.el +++ b/lisp/imenu.el @@ -829,8 +829,7 @@ A trivial interface to `imenu-add-to-menubar' suitable for use in a hook." (defvar imenu-buffer-menubar nil) (defvar-local imenu-menubar-modified-tick 0 - "The value of (buffer-chars-modified-tick) as of the last call -to `imenu-update-menubar'.") + "Value of (buffer-chars-modified-tick) when `imenu-update-menubar' was called.") (defun imenu-update-menubar () (when (and (current-local-map) diff --git a/lisp/indent.el b/lisp/indent.el index aa2bfbceebf..aa6b8d17c4a 100644 --- a/lisp/indent.el +++ b/lisp/indent.el @@ -463,7 +463,7 @@ Optional fifth argument OBJECT specifies the string or buffer to operate on." (put-text-property begin to prop (funcall func val) object)))) (defun increase-left-margin (from to inc) - "Increase or decrease the left-margin of the region. + "Increase or decrease the `left-margin' of the region. With no prefix argument, this adds `standard-indent' of indentation. A prefix arg (optional third arg INC noninteractively) specifies the amount to change the margin by, in characters. @@ -520,11 +520,14 @@ If `auto-fill-mode' is active, re-fills region to fit in new margin." (defun beginning-of-line-text (&optional n) "Move to the beginning of the text on this line. -With optional argument, move forward N-1 lines first. -From the beginning of the line, moves past the left-margin indentation, the -fill-prefix, and any indentation used for centering or right-justifying the -line, but does not move past any whitespace that was explicitly inserted -\(such as a tab used to indent the first line of a paragraph)." + +With optional argument N, move forward N-1 lines first. + +From the beginning of the line, moves past the `left-margin' +indentation, the `fill-prefix', and any indentation used for +centering or right-justifying the line, but does not move past +any whitespace that was explicitly inserted (such as a tab used +to indent the first line of a paragraph)." (interactive "^p") (beginning-of-line n) (skip-chars-forward " \t") diff --git a/lisp/info-look.el b/lisp/info-look.el index 33f15a34e99..7cc5462dd4a 100644 --- a/lisp/info-look.el +++ b/lisp/info-look.el @@ -262,7 +262,8 @@ system." (defun info-lookup-symbol (symbol &optional mode) "Display the definition of SYMBOL, as found in the relevant manual. When this command is called interactively, it reads SYMBOL from the -minibuffer. In the minibuffer, use M-n to yank the default argument +minibuffer. In the minibuffer, use \\\ +\\[next-history-element] to yank the default argument value into the minibuffer so you can edit it. The default symbol is the one found at point. @@ -276,7 +277,8 @@ With prefix arg MODE a query for the symbol help mode is offered." (defun info-lookup-file (file &optional mode) "Display the documentation of a file. When this command is called interactively, it reads FILE from the minibuffer. -In the minibuffer, use M-n to yank the default file name +In the minibuffer, use \\\ +\\[next-history-element] to yank the default file name into the minibuffer so you can edit it. The default file name is the one found at point. diff --git a/lisp/international/ccl.el b/lisp/international/ccl.el index 0eb009fa526..9be4d1ee955 100644 --- a/lisp/international/ccl.el +++ b/lisp/international/ccl.el @@ -213,8 +213,7 @@ proper index number for SYMBOL. PROP should be (ccl-embed-data (cons symbol prop))) (defun ccl-embed-string (len str) - "Embed string STR of length LEN in `ccl-program-vector' at -`ccl-current-ic'." + "Embed string STR of length LEN in `ccl-program-vector' at `ccl-current-ic'." (if (> len #xFFFFF) (error "CCL: String too long: %d" len)) (if (> (string-bytes str) len) @@ -282,8 +281,7 @@ changed to a relative jump address." (defvar ccl-loop-head nil "If non-nil, index of the start of the current loop.") (defvar ccl-breaks nil - "If non-nil, list of absolute addresses of the breaking points of -the current loop.") + "If non-nil, list of absolute addresses of breaking points of the current loop.") ;;;###autoload (defun ccl-compile (ccl-program) @@ -568,8 +566,8 @@ If READ-FLAG is non-nil, this statement has the form (cdr (cdr cmd)))) (defun ccl-compile-branch-expression (expr cmd) - "Compile EXPRESSION part of BRANCH statement and return register -which holds a value of the expression." + "Compile EXPRESSION part of BRANCH statement. +Return register which holds a value of the expression." (if (listp expr) ;; EXPR has the form `(EXPR2 OP ARG)'. Compile it as SET ;; statement of the form `(r7 = (EXPR2 OP ARG))'. @@ -1554,8 +1552,7 @@ MAP := MAP-IDs := MAP-ID ... MAP-SET := MAP-IDs | (MAP-IDs) MAP-SET -MAP-ID := integer -" +MAP-ID := integer" (declare (doc-string 3)) `(let ((prog ,(unwind-protect (progn diff --git a/lisp/international/quail.el b/lisp/international/quail.el index c0e53d26fba..50ff307b73a 100644 --- a/lisp/international/quail.el +++ b/lisp/international/quail.el @@ -471,7 +471,8 @@ conversion region is active. It is an alist of single key character vs. corresponding command to be called. If SIMPLE is non-nil, then we do not alter the meanings of -commands such as C-f, C-b, C-n, C-p and TAB; they are treated as +commands such as \\[forward-char], \\[backward-char], \\[next-line], \ +\\[previous-line] and \\[indent-for-tab-command]; they are treated as non-Quail commands." (let (translation-keymap conversion-keymap) (if deterministic (setq forget-last-selection t)) diff --git a/lisp/international/robin.el b/lisp/international/robin.el index e4a11801c38..c38cd822693 100644 --- a/lisp/international/robin.el +++ b/lisp/international/robin.el @@ -276,8 +276,7 @@ this robin package will be the following. (?c \"AC\" (?d \"ACD\") (?e \"ACE\"))) - (?b \"B\")) -") + (?b \"B\"))") ;;;###autoload (defmacro robin-define-package (name docstring &rest rules) diff --git a/lisp/isearch.el b/lisp/isearch.el index 952caa7ac22..242f2b0dd09 100644 --- a/lisp/isearch.el +++ b/lisp/isearch.el @@ -1221,7 +1221,7 @@ is processed. (It is not called after characters that exit the search.) When the arg RECURSIVE-EDIT is non-nil, this function behaves modally and does not return to the calling function until the search is completed. -To behave this way it enters a recursive-edit and exits it when done +To behave this way it enters a recursive edit and exits it when done isearching. The arg REGEXP-FUNCTION, if non-nil, should be a function. It is diff --git a/lisp/jit-lock.el b/lisp/jit-lock.el index c1a5bbe9478..bb2df2b1ffa 100644 --- a/lisp/jit-lock.el +++ b/lisp/jit-lock.el @@ -47,7 +47,7 @@ Preserves the `buffer-modified-p' state of the current buffer." (defcustom jit-lock-chunk-size 1500 "Jit-lock fontifies chunks of at most this many characters at a time. -This variable controls both display-time and stealth fontification. +This variable controls both `display-time' and stealth fontification. The optimum value is a little over the typical number of buffer characters which fit in a typical window." diff --git a/lisp/kmacro.el b/lisp/kmacro.el index a39f433cdc3..53e6e5e288a 100644 --- a/lisp/kmacro.el +++ b/lisp/kmacro.el @@ -820,8 +820,8 @@ If kbd macro currently being defined end it before activating it." (defun kmacro-bind-to-key (_arg) "When not defining or executing a macro, offer to bind last macro to a key. -The key sequences [C-x C-k 0] through [C-x C-k 9] and [C-x C-k A] -through [C-x C-k Z] are reserved for user bindings, and to bind to +The key sequences `C-x C-k 0' through `C-x C-k 9' and `C-x C-k A' +through `C-x C-k Z' are reserved for user bindings, and to bind to one of these sequences, just enter the digit or letter, rather than the whole sequence. diff --git a/lisp/loadhist.el b/lisp/loadhist.el index 0b12bdad058..4a7946a212b 100644 --- a/lisp/loadhist.el +++ b/lisp/loadhist.el @@ -168,8 +168,7 @@ documentation of `unload-feature' for details.") ;; So we use this auxiliary variable to keep track of the last (t . SYMBOL) ;; that occurred. (defvar loadhist--restore-autoload nil - "If non-nil, this is a symbol for which we should -restore a previous autoload if possible.") + "If non-nil, is a symbol for which to try to restore a previous autoload.") (cl-defmethod loadhist-unload-element ((x (head t))) (setq loadhist--restore-autoload (cdr x))) diff --git a/lisp/locate.el b/lisp/locate.el index 008d65e055f..6190fc6302a 100644 --- a/lisp/locate.el +++ b/lisp/locate.el @@ -50,7 +50,7 @@ ;; from a shell prompt. GNU locate and BSD find expect the file databases ;; to either be in standard places or located via environment variables. ;; If the latter, make sure these environment variables are set in -;; your emacs process. +;; your Emacs process. ;; ;; Locate-mode assumes that each line output from the locate-command ;; consists exactly of a file name, possibly preceded or trailed by diff --git a/lisp/macros.el b/lisp/macros.el index 689c4210cd7..89e38abab2d 100644 --- a/lisp/macros.el +++ b/lisp/macros.el @@ -148,11 +148,16 @@ use this command, and then save the file." ;;;###autoload (defun kbd-macro-query (flag) "Query user during kbd macro execution. - With prefix argument, enters recursive edit, reading keyboard -commands even within a kbd macro. You can give different commands -each time the macro executes. - Without prefix argument, asks whether to continue running the macro. + +With prefix argument FLAG, enter recursive edit, reading +keyboard commands even within a kbd macro. You can give +different commands each time the macro executes. + +Without prefix argument, ask whether to continue running the +macro. + Your options are: \\ + \\[act] Finish this iteration normally and continue with the next. \\[skip] Skip the rest of this iteration, and start the next. \\[exit] Stop the macro entirely right now. diff --git a/lisp/menu-bar.el b/lisp/menu-bar.el index 07f7beb92c8..e84eec5002c 100644 --- a/lisp/menu-bar.el +++ b/lisp/menu-bar.el @@ -2156,7 +2156,7 @@ otherwise it could decide to silently do nothing." (> count 1))) (defcustom yank-menu-length 20 - "Maximum length to display in the yank-menu." + "Maximum length to display in the `yank-menu'." :type 'integer :group 'menu) @@ -2289,7 +2289,7 @@ Buffers menu is regenerated." It must accept a buffer as its only required argument.") (defun menu-bar-buffer-vector (alist) - ;; turn ((name . buffer) ...) into a menu + "Turn ((name . buffer) ...) into a menu." (let ((buffers-vec (make-vector (length alist) nil)) (i (length alist))) (dolist (pair alist) @@ -2303,7 +2303,7 @@ It must accept a buffer as its only required argument.") buffers-vec)) (defun menu-bar-update-buffers (&optional force) - ;; If user discards the Buffers item, play along. + "If user discards the Buffers item, play along." (and (lookup-key (current-global-map) [menu-bar buffer]) (or force (frame-or-buffer-changed-p)) (let ((buffers (buffer-list)) diff --git a/lisp/mouse-drag.el b/lisp/mouse-drag.el index b424b6edfe8..ecfb359b36f 100644 --- a/lisp/mouse-drag.el +++ b/lisp/mouse-drag.el @@ -147,7 +147,7 @@ Keep the cursor on the screen as needed." (= (cdr start-col-row) (cdr end-col-row))))) (defvar mouse-drag-electric-col-scrolling t - "If non-nil, mouse-drag on a long line enables truncate-lines.") + "If non-nil, mouse-drag on a long line enables `truncate-lines'.") (defun mouse-drag-should-do-col-scrolling () "Determine if it's wise to enable col-scrolling for the current window. diff --git a/lisp/mouse.el b/lisp/mouse.el index edac5085ff8..41333eb7f71 100644 --- a/lisp/mouse.el +++ b/lisp/mouse.el @@ -46,7 +46,7 @@ :type 'boolean) (defcustom mouse-drag-copy-region nil - "If non-nil, copy to kill-ring upon mouse adjustments of the region. + "If non-nil, copy to kill ring upon mouse adjustments of the region. This affects `mouse-save-then-kill' (\\[mouse-save-then-kill]) in addition to mouse drags. diff --git a/lisp/nxml/nxml-mode.el b/lisp/nxml/nxml-mode.el index c5c9dfb2afc..98ce1d6993e 100644 --- a/lisp/nxml/nxml-mode.el +++ b/lisp/nxml/nxml-mode.el @@ -455,8 +455,9 @@ reference.") ;; because Emacs turns C-c C-i into C-c TAB which is hard to type and ;; not mnemonic. "Major mode for editing XML. - +\\ \\[nxml-finish-element] finishes the current element by inserting an end-tag. + C-c C-i closes a start-tag with `>' and then inserts a balancing end-tag leaving point between the start-tag and end-tag. \\[nxml-balanced-close-start-tag-block] is similar but for block rather than inline elements: diff --git a/lisp/nxml/rng-loc.el b/lisp/nxml/rng-loc.el index a38da794226..c8b19e8c229 100644 --- a/lisp/nxml/rng-loc.el +++ b/lisp/nxml/rng-loc.el @@ -501,7 +501,7 @@ saved to the first writable file in `rng-schema-locating-files'." nil (error "Buffer does not have a filename"))) ((and prompt - (not (y-or-n-p (format "Save %s to %s " + (not (y-or-n-p (format "Save %s to %s?" (if type-id "type identifier" "schema location") @@ -539,7 +539,7 @@ saved to the first writable file in `rng-schema-locating-files'." locating-file-uri)))))) (indent-according-to-mode) (when (or (not modified) - (y-or-n-p (format "Save file %s " + (y-or-n-p (format "Save file %s?" (buffer-file-name)))) (save-buffer)))))))) diff --git a/lisp/nxml/rng-valid.el b/lisp/nxml/rng-valid.el index fca666115a2..9df20a16b1d 100644 --- a/lisp/nxml/rng-valid.el +++ b/lisp/nxml/rng-valid.el @@ -962,9 +962,8 @@ Return nil at end of buffer, t otherwise." (and type t))) (defun rng-process-start-tag (tag-type) - "TAG-TYPE is `start-tag' for a start-tag, `empty-element' for -an empty element. `partial-empty-element' should be passed -as empty-element." + "TAG-TYPE is `start-tag' for a start-tag, `empty-element' for an empty element. +`partial-empty-element' should be passed as empty-element." (and rng-collecting-text (rng-flush-text)) (setq rng-collecting-text nil) (setq rng-pending-contents nil) diff --git a/lisp/pcmpl-x.el b/lisp/pcmpl-x.el index fd147101b69..d9479edf6a6 100644 --- a/lisp/pcmpl-x.el +++ b/lisp/pcmpl-x.el @@ -21,6 +21,8 @@ ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs. If not, see . +;;; Commentary: + ;;; Code: (eval-when-compile (require 'cl-lib)) diff --git a/lisp/play/5x5.el b/lisp/play/5x5.el index 1d193306296..085c97f5d8e 100644 --- a/lisp/play/5x5.el +++ b/lisp/play/5x5.el @@ -387,7 +387,7 @@ Mutate the result." (defun 5x5-crack (breeder) "Attempt to find a solution for 5x5. -5x5-crack takes the argument BREEDER which should be a function that takes +`5x5-crack' takes the argument BREEDER which should be a function that takes two parameters, the first will be a grid vector array that is the current solution and the second will be the best solution so far. The function should return a grid vector array that is the new solution." @@ -474,8 +474,8 @@ position." grid))) (defun 5x5-vec-to-grid (grid-matrix) - "Convert a grid matrix GRID-MATRIX in Calc format to a grid in -5x5 format. See function `5x5-grid-to-vec'." + "Convert a grid matrix GRID-MATRIX in Calc format to a grid in 5x5 format. +See function `5x5-grid-to-vec'." (apply #'vector (mapcar diff --git a/lisp/play/doctor.el b/lisp/play/doctor.el index 9777fc3ea24..b855f7e35a1 100644 --- a/lisp/play/doctor.el +++ b/lisp/play/doctor.el @@ -115,7 +115,7 @@ (defun doc// (x) x) (defmacro doc$ (what) - "Quoted arg form of doctor-$." + "Quoted arg form of `doctor-$'." `(doctor-$ ',what)) (defun doctor-$ (what) @@ -1011,7 +1011,7 @@ Put dialogue in buffer." (defun doctor-subjsearch (sent key type) "Search for the subject of a sentence SENT, looking for the noun closest -to and preceding KEY by at least TYPE words. Set global variable doctor-subj to +to and preceding KEY by at least TYPE words. Set global variable `doctor-subj' to the subject noun, and return the portion of the sentence following it." (let ((i (- (length sent) (length (memq key sent)) type))) (while (and (> i -1) (not (doctor-nounp (nth i sent)))) diff --git a/lisp/play/dunnet.el b/lisp/play/dunnet.el index d9acad8e43e..706c1be81e0 100644 --- a/lisp/play/dunnet.el +++ b/lisp/play/dunnet.el @@ -944,8 +944,8 @@ handled specially by 'dun-describe-room.") (list obj-pc) ;; pc-area nil nil nil nil nil nil ) - "These are objects in a room that are only described in the -room description. They are permanent.") + "These are objects in a room that are only described in the room description. +They are permanent.") (defvar dun-inventory '(1)) (defconst dun-objects @@ -1010,8 +1010,7 @@ the inventory.") nil nil ("There is a bus here.") nil nil nil) - "These are the descriptions for the negative numbered objects from -`dun-room-objects'.") + "Descriptions for the negative numbered objects from `dun-room-objects'.") (defconst dun-physobj-desc '( @@ -1216,8 +1215,9 @@ Otherwise short. Also give long if we were called with negative room number." (dun-mprincl "You are on the bus.")))) (defun dun-special-object () - "There is a special object in the room. This object's description, -or lack thereof, depends on certain conditions." + "There is a special object in the room. +This object's description, or lack thereof, depends on certain +conditions." (cond ((= dun-current-room computer-room) (if dun-computer diff --git a/lisp/play/hanoi.el b/lisp/play/hanoi.el index d3d0ad1309c..227dd790af5 100644 --- a/lisp/play/hanoi.el +++ b/lisp/play/hanoi.el @@ -133,7 +133,7 @@ Repent before ring 31 moves." (defun hanoi-unix-64 () "Like `hanoi-unix', but pretend to have a 64-bit clock. This is, necessarily (as of Emacs 20.3), a crock. When the -current-time interface is made s2G-compliant, hanoi.el will need +`current-time' interface is made s2G-compliant, hanoi.el will need to be updated." (interactive) (let* ((start (ftruncate (float-time))) diff --git a/lisp/play/mpuz.el b/lisp/play/mpuz.el index 5ac1d7c60c2..ff174fed6c2 100644 --- a/lisp/play/mpuz.el +++ b/lisp/play/mpuz.el @@ -119,7 +119,7 @@ You may abort a game by typing \\\\[mpuz-offer-abort]." ;; Some variables for game tracking ;;--------------------------------- (defvar mpuz-in-progress nil - "True if a game is currently in progress.") + "Non-nil if a game is currently in progress.") (defvar mpuz-found-digits (make-bool-vector 10 nil) "A vector recording which digits have been decrypted.") diff --git a/lisp/play/tetris.el b/lisp/play/tetris.el index f43aa47326f..3d6ddd5307f 100644 --- a/lisp/play/tetris.el +++ b/lisp/play/tetris.el @@ -620,7 +620,7 @@ Shapes drop from the top of the screen, and the user has to move and rotate the shape to fit in with those at the bottom of the screen so as to form complete rows. -tetris-mode keybindings: +`tetris-mode' keybindings: \\ \\[tetris-start-game] Start a new game of Tetris \\[tetris-end-game] Terminate the current game diff --git a/lisp/printing.el b/lisp/printing.el index 89e49ccb2a4..fb718f9aa62 100644 --- a/lisp/printing.el +++ b/lisp/printing.el @@ -1672,7 +1672,7 @@ DEFAULT It's a way to set default values when this entry is selected. (set VARIABLE (eval VALUE)) - Note that VALUE can be any valid lisp expression. So, don't + Note that VALUE can be any valid Lisp expression. So, don't forget to quote symbols and constant lists. If VARIABLE is the special keyword `inherits-from:', VALUE must be a symbol name setting defined in `pr-setting-database' from @@ -1772,8 +1772,7 @@ Useful links: `https://linux.die.net/man/1/lp' * GNU utilities for w32 (cp.exe) - `http://unxutils.sourceforge.net/' -" + `http://unxutils.sourceforge.net/'" :type '(repeat (list :tag "PostScript Printer" @@ -2181,7 +2180,7 @@ DEFAULT It's a way to set default values when this entry is selected. (set (make-local-variable VARIABLE-SYM) (eval VALUE)) - Note that VALUE can be any valid lisp expression. So, don't + Note that VALUE can be any valid Lisp expression. So, don't forget to quote symbols and constant lists. If VARIABLE is the special keyword `inherits-from:', VALUE must be a symbol name setting defined in `pr-setting-database' from @@ -2413,8 +2412,7 @@ Useful links: * GNU Enscript documentation (Windows, GNU or Unix) `https://people.ssh.com/mtr/genscript/enscript.man.html' - (on GNU or Unix, type `man enscript') -" + (on GNU or Unix, type `man enscript')" :type '(repeat (list :tag "PS File Utility" (symbol :tag "Utility Symbol") @@ -4276,7 +4274,7 @@ printed using `pr-ps-mode-ps-print'. Interactively, you have the following situations: - M-x pr-ps-fast-fire RET + \\[pr-ps-fast-fire] The command prompts the user for a N-UP value and printing will immediately be done using the current active printer. diff --git a/lisp/profiler.el b/lisp/profiler.el index 0b456bb3e31..fa74fe8de25 100644 --- a/lisp/profiler.el +++ b/lisp/profiler.el @@ -105,8 +105,8 @@ ;;; Entries (defun profiler-format-entry (entry) - "Format ENTRY in human readable string. ENTRY would be a -function name of a function itself." + "Format ENTRY in human readable string. +ENTRY would be a function name of a function itself." (cond ((memq (car-safe entry) '(closure lambda)) (format "#" (sxhash entry))) ((byte-code-function-p entry) @@ -463,7 +463,7 @@ Optional argument MODE means only check for the specified mode (cpu or mem)." "The current profile.") (defvar-local profiler-report-reversed nil - "True if calltree is rendered in bottom-up. + "Non-nil if calltree is rendered in bottom-up. Do not touch this variable directly.") (defvar-local profiler-report-order nil diff --git a/lisp/progmodes/cc-bytecomp.el b/lisp/progmodes/cc-bytecomp.el index f07f18678a2..b6805898b0e 100644 --- a/lisp/progmodes/cc-bytecomp.el +++ b/lisp/progmodes/cc-bytecomp.el @@ -339,8 +339,8 @@ should be a string. CONDITION should not be quoted." '(progn))) (defmacro cc-provide (feature) - "A replacement for the `provide' form that restores the environment -after the compilation. Don't use within `eval-when-compile'." + "A replacement for `provide' that restores the environment after the compilation. +Don't use within `eval-when-compile'." (declare (debug t)) `(progn (eval-when-compile (cc-bytecomp-restore-environment)) @@ -381,8 +381,9 @@ afterwards. Don't use within `eval-when-compile'." (eval-when-compile (cc-bytecomp-setup-environment)))) (defmacro cc-bytecomp-defvar (var) - "Bind the symbol as a variable during compilation of the file, -to silence the byte compiler. Don't use within `eval-when-compile'." + "Bind the symbol VAR as a variable during compilation of the file. +This can be used to silence the byte compiler. Don't use within +`eval-when-compile'." (declare (debug nil)) `(eval-when-compile (if (boundp ',var) @@ -403,8 +404,9 @@ to silence the byte compiler. Don't use within `eval-when-compile'." "cc-bytecomp-defvar: Covered variable %s" ',var)))))) (defmacro cc-bytecomp-defun (fun) - "Bind the symbol as a function during compilation of the file, -to silence the byte compiler. Don't use within `eval-when-compile'. + "Bind the symbol FUN as a function during compilation of the file. +This can be used to silence the byte compiler. Don't use within +`eval-when-compile'. If the symbol already is bound as a function, it will keep that definition. That means that this macro will not shut up warnings @@ -431,8 +433,8 @@ at compile time, e.g. for macros and inline functions." "cc-bytecomp-defun: Covered function %s" ',fun)))))) (defmacro cc-bytecomp-put (symbol propname value) - "Set a property on a symbol during compilation (and evaluation) of -the file. Don't use outside `eval-when-compile'." + "Set a property on SYMBOL during compilation (and evaluation) of the file. +Don't use outside `eval-when-compile'." (declare (debug t)) `(eval-when-compile (if (not (assoc (cons ,symbol ,propname) cc-bytecomp-original-properties)) @@ -450,9 +452,9 @@ the file. Don't use outside `eval-when-compile'." ,propname ,symbol ,value))) (defmacro cc-bytecomp-boundp (symbol) - "Return non-nil if the given symbol is bound as a variable outside -the compilation. This is the same as using `boundp' but additionally -exclude any variables that have been bound during compilation with + "Return non-nil if SYMBOL is bound as a variable outside the compilation. +This is the same as using `boundp' but additionally exclude any +variables that have been bound during compilation with `cc-bytecomp-defvar'." (declare (debug t)) (if (and (cc-bytecomp-is-compiling) @@ -461,9 +463,9 @@ exclude any variables that have been bound during compilation with `(boundp ,symbol))) (defmacro cc-bytecomp-fboundp (symbol) - "Return non-nil if the given symbol is bound as a function outside -the compilation. This is the same as using `fboundp' but additionally -exclude any functions that have been bound during compilation with + "Return non-nil if SYMBOL is bound as a function outside the compilation. +This is the same as using `fboundp' but additionally exclude any +functions that have been bound during compilation with `cc-bytecomp-defun'." (declare (debug t)) (let (fun-elem) diff --git a/lisp/progmodes/cc-cmds.el b/lisp/progmodes/cc-cmds.el index 217281b8a24..6c3da667bfc 100644 --- a/lisp/progmodes/cc-cmds.el +++ b/lisp/progmodes/cc-cmds.el @@ -5113,8 +5113,9 @@ inside a preprocessor directive." (defun c-context-open-line () "Insert a line break suitable to the context and leave point before it. -This is the `c-context-line-break' equivalent to `open-line', which is -normally bound to C-o. See `c-context-line-break' for the details." +This is the `c-context-line-break' equivalent to `open-line' +\(bound to \\[open-line]). See `c-context-line-break' for the +details." (interactive "*") (let ((here (point))) (unwind-protect diff --git a/lisp/progmodes/cc-defs.el b/lisp/progmodes/cc-defs.el index be0b40fd6c2..12e10c26eec 100644 --- a/lisp/progmodes/cc-defs.el +++ b/lisp/progmodes/cc-defs.el @@ -827,9 +827,9 @@ right side of it." ;; impossible to get a feel for how that function works. (defmacro c-go-list-forward (&optional pos limit) - "Move forward across one balanced group of parentheses starting at POS or -point. Return POINT when we succeed, NIL when we fail. In the latter case, -leave point unmoved. + "Move forward across one balanced group of parentheses starting at POS or point. +Return POINT when we succeed, NIL when we fail. In the latter +case, leave point unmoved. A LIMIT for the search may be given. The start position is assumed to be before it." @@ -838,9 +838,9 @@ before it." (when dest (goto-char dest) dest))) (defmacro c-go-list-backward (&optional pos limit) - "Move backward across one balanced group of parentheses starting at POS or -point. Return POINT when we succeed, NIL when we fail. In the latter case, -leave point unmoved. + "Move backward across one balanced group of parentheses starting at POS or point. +Return POINT when we succeed, NIL when we fail. In the latter +case, leave point unmoved. A LIMIT for the search may be given. The start position is assumed to be after it." @@ -2593,7 +2593,7 @@ quoted." (defvar c-lang-constants-under-evaluation nil "Alist of constants in the process of being evaluated. The `cdr' of each entry indicates how far we've looked in the list -of definitions, so that the def for var FOO in c-mode can be defined in +of definitions, so that the def for var FOO in `c-mode' can be defined in terms of the def for that same var FOO (which will then rely on the fallback definition for all modes, to break the cycle).") diff --git a/lisp/progmodes/cc-engine.el b/lisp/progmodes/cc-engine.el index 53c382f018c..20cdb72ccf1 100644 --- a/lisp/progmodes/cc-engine.el +++ b/lisp/progmodes/cc-engine.el @@ -1545,7 +1545,7 @@ comment at the start of cc-engine.el for more info." nil)))))) (defun c-at-statement-start-p () - "Return non-nil if the point is at the first token in a statement + "Return non-nil if point is at the first token in a statement or somewhere in the syntactic whitespace before it. A \"statement\" here is not restricted to those inside code blocks. @@ -1574,7 +1574,7 @@ comment at the start of cc-engine.el for more info." (c-crosses-statement-barrier-p (point) end))))) (defun c-at-expression-start-p () - "Return non-nil if the point is at the first token in an expression or + "Return non-nil if point is at the first token in an expression or statement, or somewhere in the syntactic whitespace before it. An \"expression\" here is a bit different from the normal language @@ -4969,7 +4969,7 @@ out of an enclosing paren." nil)))) (defun c-forward-over-token-and-ws (&optional balanced) - "Move forward over a token and any following whitespace + "Move forward over a token and any following whitespace. Return t if we moved, nil otherwise (i.e. we were at EOB, or a non-token or BALANCED is non-nil and we can't move). If we are at syntactic whitespace, move over this in place of a token. @@ -5384,8 +5384,8 @@ comment at the start of cc-engine.el for more info." (defvar safe-pos-list) ; bound in c-syntactic-skip-backward (defun c-syntactic-skip-backward (skip-chars &optional limit paren-level) - "Like `skip-chars-backward' but only look at syntactically relevant chars, -i.e. don't stop at positions inside syntactic whitespace or string + "Like `skip-chars-backward' but only look at syntactically relevant chars. +This means don't stop at positions inside syntactic whitespace or string literals. Preprocessor directives are also ignored, with the exception of the one that the point starts within, if any. If LIMIT is given, it's assumed to be at a syntactically relevant position. diff --git a/lisp/progmodes/cc-fonts.el b/lisp/progmodes/cc-fonts.el index 7e7053b98e1..bc0ae6cc95a 100644 --- a/lisp/progmodes/cc-fonts.el +++ b/lisp/progmodes/cc-fonts.el @@ -1765,7 +1765,7 @@ casts and declarations are fontified. Used on level 2 and higher." (> (match-beginning 0) (point-min)) (memq (c-get-char-property (1- (match-beginning 0)) 'face) '(font-lock-comment-face font-lock-string-face - font-lock-comment-delimiter-face)))) + font-lock-comment-delimiter-face)))) (when found (setq open-delim (cons (match-beginning 1) (cons (match-end 1) (match-beginning 2))) diff --git a/lisp/progmodes/cc-langs.el b/lisp/progmodes/cc-langs.el index b106454b11e..36f12369fca 100644 --- a/lisp/progmodes/cc-langs.el +++ b/lisp/progmodes/cc-langs.el @@ -4178,8 +4178,7 @@ aliases in Emacs are resolved." (cdr c-emacs-variable-inits)))) (defun c-make-init-lang-vars-fun (mode) - "Create a function that initializes all the language dependent variables -for the given mode. + "Create a function that initializes all language dependent variables for MODE. This function should be evaluated at compile time, so that the function it returns is byte compiled with all the evaluated results diff --git a/lisp/progmodes/cc-mode.el b/lisp/progmodes/cc-mode.el index c818c1a3582..8b302414496 100644 --- a/lisp/progmodes/cc-mode.el +++ b/lisp/progmodes/cc-mode.el @@ -1648,7 +1648,7 @@ Note that the style variables are always made local to the buffer." (and (memq (char-before) c-string-delims) (not (nth 4 s))))) ; Check we're actually out of the ; comment. not stuck at EOB - (unless + (unless (and c-ml-string-opener-re (c-maybe-re-mark-ml-string)) (if (c-unescaped-nls-in-string-p (1- (point))) diff --git a/lisp/progmodes/cc-vars.el b/lisp/progmodes/cc-vars.el index dcd9546d9aa..8869c565737 100644 --- a/lisp/progmodes/cc-vars.el +++ b/lisp/progmodes/cc-vars.el @@ -1227,7 +1227,7 @@ can always override the use of `c-default-style' by making calls to ;; Anchor pos: None. )) (defcustom c-offsets-alist nil - "Association list of syntactic element symbols and indentation offsets. + "Alist of syntactic element symbols and indentation offsets. As described below, each cons cell in this list has the form: (SYNTACTIC-SYMBOL . OFFSET) diff --git a/lisp/progmodes/cmacexp.el b/lisp/progmodes/cmacexp.el index 0f7c8c6f31a..07648ac623c 100644 --- a/lisp/progmodes/cmacexp.el +++ b/lisp/progmodes/cmacexp.el @@ -101,7 +101,7 @@ :type 'boolean) (defcustom c-macro-prompt-flag nil - "Non-nil makes `c-macro-expand' prompt for preprocessor arguments." + "Non-nil means `c-macro-expand' will prompt for preprocessor arguments." :type 'boolean) (defcustom c-macro-preprocessor diff --git a/lisp/progmodes/compile.el b/lisp/progmodes/compile.el index 6b521e8d90b..73f98068110 100644 --- a/lisp/progmodes/compile.el +++ b/lisp/progmodes/compile.el @@ -687,11 +687,13 @@ matched file names, and weeding out false positives." ,(expand-file-name "compilation.txt" data-directory))) (defvar compilation-error-case-fold-search nil - "If non-nil, use case-insensitive matching of compilation errors -by the regexps of `compilation-error-regexp-alist' and -`compilation-error-regexp-alist-alist'. + "If non-nil, use case-insensitive matching of compilation errors. If nil, matching is case-sensitive. +Compilation errors are given by the regexps in +`compilation-error-regexp-alist' and +`compilation-error-regexp-alist-alist'. + This variable should only be set for backward compatibility as a temporary measure. The proper solution is to use a regexp that matches the messages without case-folding.") diff --git a/lisp/progmodes/cperl-mode.el b/lisp/progmodes/cperl-mode.el index 634dd29bad6..c371a84b9d2 100644 --- a/lisp/progmodes/cperl-mode.el +++ b/lisp/progmodes/cperl-mode.el @@ -361,14 +361,14 @@ Affects: `cperl-font-lock', `cperl-electric-lbrace-space', ;; :group 'cperl) (defcustom cperl-info-on-command-no-prompt nil - "Not-nil (and non-null) means not to prompt on C-h f. + "Not-nil (and non-null) means not to prompt on \\[cperl-info-on-command]. The opposite behavior is always available if prefixed with C-c. Can be overwritten by `cperl-hairy' if nil." :type '(choice (const null) boolean) :group 'cperl-affected-by-hairy) (defcustom cperl-clobber-lisp-bindings nil - "Not-nil (and non-null) means not overwrite C-h f. + "Not-nil (and non-null) means not overwrite \\[describe-function]. The function is available on \\[cperl-info-on-command], \\[cperl-get-help]. Can be overwritten by `cperl-hairy' if nil." :type '(choice (const null) boolean) diff --git a/lisp/progmodes/cpp.el b/lisp/progmodes/cpp.el index 6602a79b2a4..d800365e66d 100644 --- a/lisp/progmodes/cpp.el +++ b/lisp/progmodes/cpp.el @@ -711,8 +711,8 @@ BRANCH should be either nil (false branch), t (true branch) or `both'." default)) (defun cpp-choose-default-face (type) - ;; Choose default face list for screen of TYPE. - ;; Type must be one of the types defined in `cpp-face-type-list'. + "Choose default face list for screen of TYPE. +Type must be one of the types defined in `cpp-face-type-list'." (interactive (list (if cpp-button-event (x-popup-menu cpp-button-event (list "Screen type" @@ -789,7 +789,7 @@ BRANCH should be either nil (false branch), t (true branch) or `both'." (if data (list 'cpp-data data)))))) (defun cpp-push-button (event) - ;; Pushed a CPP button. + "Pushed a CPP button." (interactive "@e") (set-buffer (window-buffer (posn-window (event-start event)))) (let ((pos (posn-point (event-start event)))) diff --git a/lisp/progmodes/dcl-mode.el b/lisp/progmodes/dcl-mode.el index ed024f24344..b74b558f8df 100644 --- a/lisp/progmodes/dcl-mode.el +++ b/lisp/progmodes/dcl-mode.el @@ -494,7 +494,7 @@ Variables controlling indentation style and extra features: These variables control the look of expanded templates. dcl-imenu-generic-expression - Default value for imenu-generic-expression. The default includes + Default value for `imenu-generic-expression'. The default includes SUBROUTINE labels in the main listing and sub-listings for other labels, CALL, GOTO and GOSUB statements. @@ -1463,7 +1463,7 @@ Inserts continuation marks and splits character strings." ;;;------------------------------------------------------------------------- (defun dcl-delete-indentation (&optional arg) - "Join this line to previous like delete-indentation. + "Join this line to previous like `delete-indentation'. Also remove the continuation mark if easily detected." (interactive "*P") (delete-indentation arg) diff --git a/lisp/progmodes/ebnf-yac.el b/lisp/progmodes/ebnf-yac.el index 816cc432d1b..84950e45f51 100644 --- a/lisp/progmodes/ebnf-yac.el +++ b/lisp/progmodes/ebnf-yac.el @@ -113,7 +113,7 @@ ;;; YACC-Code = "any C definition". (defun ebnf-yac-parser (start) - "yacc/Bison parser." + "Yacc/Bison parser." (let ((total (+ (- ebnf-limit start) 1)) (bias (1- start)) (origin (point)) diff --git a/lisp/progmodes/f90.el b/lisp/progmodes/f90.el index 3f2c9b71485..f9e6101e7ab 100644 --- a/lisp/progmodes/f90.el +++ b/lisp/progmodes/f90.el @@ -65,8 +65,8 @@ ;; the variable f90-comment-region in every line of the region. ;; One common convention for free vs. fixed format is that free format -;; files have the ending .f90 or .f95 while fixed format files have -;; the ending .f. Emacs automatically loads Fortran files in the +;; files have the ending ".f90" or ".f95" while fixed format files have +;; the ending ".f". Emacs automatically loads Fortran files in the ;; appropriate mode based on extension. You can modify this by ;; adjusting the variable `auto-mode-alist'. ;; For example: @@ -984,7 +984,7 @@ Used in the F90 entry in `hs-special-modes-alist'.") ;; FIXME trivial to extend this to enum. Worth it? (defun f90-imenu-type-matcher () "Search backward for the start of a derived type. -Set subexpression 1 in the match-data to the name of the type." +Set subexpression 1 in the `match-data' to the name of the type." (let (found) (while (and (re-search-backward "^[ \t0-9]*type[ \t]*" nil t) (not (setq found diff --git a/lisp/progmodes/flymake.el b/lisp/progmodes/flymake.el index e8ce0e723e4..9418debe5e3 100644 --- a/lisp/progmodes/flymake.el +++ b/lisp/progmodes/flymake.el @@ -559,7 +559,7 @@ Currently accepted REPORT-KEY arguments are: (put :warning 'flymake-category 'flymake-warning) (put :note 'flymake-category 'flymake-note) -(defvar flymake-diagnostic-types-alist '() "") +(defvar flymake-diagnostic-types-alist '()) (make-obsolete-variable 'flymake-diagnostic-types-alist "Set properties on the diagnostic symbols instead. See Info @@ -1329,7 +1329,7 @@ default) no filter is applied." ;;; Mode-line and menu ;;; -(easy-menu-define flymake-menu flymake-mode-map "Flymake" +(easy-menu-define flymake-menu flymake-mode-map "Flymake menu." '("Flymake" [ "Go to next problem" flymake-goto-next-error t ] [ "Go to previous problem" flymake-goto-prev-error t ] diff --git a/lisp/progmodes/gdb-mi.el b/lisp/progmodes/gdb-mi.el index 902466e4feb..3e5b8e2f32b 100644 --- a/lisp/progmodes/gdb-mi.el +++ b/lisp/progmodes/gdb-mi.el @@ -467,8 +467,8 @@ GDB session needs to be restarted for this setting to take effect." ;; TODO Some commands can't be called with --all (give a notice about ;; it in setting doc) (defcustom gdb-gud-control-all-threads t - "When non-nil, GUD execution commands affect all threads when -in non-stop mode. Otherwise, only current thread is affected." + "When non-nil, GUD execution commands affect all threads when in non-stop mode. +Otherwise, only current thread is affected." :type 'boolean :group 'gdb-non-stop :version "23.2") @@ -1483,7 +1483,7 @@ INDENT is the current indentation depth." (expr (nth 1 var)) (children (nth 2 var))) (if (or (<= (string-to-number children) gdb-max-children) (y-or-n-p - (format "%s has %s children. Continue? " expr children))) + (format "%s has %s children. Continue?" expr children))) (gdb-var-list-children token)))) ((string-search "-" text) ;contract this node (dolist (var gdb-var-list) diff --git a/lisp/progmodes/grep.el b/lisp/progmodes/grep.el index d7f4582dd0b..ec2850737c8 100644 --- a/lisp/progmodes/grep.el +++ b/lisp/progmodes/grep.el @@ -72,7 +72,7 @@ SYMBOL should be one of `grep-command', `grep-template', Some grep programs are able to surround matches with special markers in grep output. Such markers can be used to highlight matches in grep mode. This requires `font-lock-mode' to be active -in grep buffers, so if you have globally disabled font-lock-mode, +in grep buffers, so if you have globally disabled `font-lock-mode', you will not get highlighting. This option sets the environment variable GREP_COLORS to specify @@ -137,7 +137,7 @@ The following place holders should be present in the string: - file names and wildcards to search. - file names and wildcards to exclude. - the regular expression searched for. - - place to insert null-device. + - place to insert `null-device'. In interactive usage, the actual value of this variable is set up by `grep-compute-defaults'; to change the default value, use diff --git a/lisp/progmodes/hideshow.el b/lisp/progmodes/hideshow.el index b2557587c6c..e2ad480281f 100644 --- a/lisp/progmodes/hideshow.el +++ b/lisp/progmodes/hideshow.el @@ -62,7 +62,7 @@ ;; activated or deactivated, `hs-minor-mode-hook' is run w/ `run-hooks'. ;; ;; Additionally, Joseph Eydelnant writes: -;; I enjoy your package hideshow.el Ver. 5.24 2001/02/13 +;; I enjoy your package hideshow.el Version 5.24 2001/02/13 ;; a lot and I've been looking for the following functionality: ;; toggle hide/show all with a single key. ;; Here are a few lines of code that lets me do just that. diff --git a/lisp/progmodes/idlwave.el b/lisp/progmodes/idlwave.el index 36f8a6d6b6e..d6828eeffbb 100644 --- a/lisp/progmodes/idlwave.el +++ b/lisp/progmodes/idlwave.el @@ -5316,7 +5316,7 @@ directories and save the routine info. (defun idlwave-delete-user-catalog-file (&rest _ignore) (if (yes-or-no-p - (format "Delete file %s " idlwave-user-catalog-file)) + (format "Delete file %s?" idlwave-user-catalog-file)) (progn (delete-file idlwave-user-catalog-file) (message "%s has been deleted" idlwave-user-catalog-file)))) diff --git a/lisp/progmodes/opascal.el b/lisp/progmodes/opascal.el index 51c888d25f3..e55b09d8fcf 100644 --- a/lisp/progmodes/opascal.el +++ b/lisp/progmodes/opascal.el @@ -51,7 +51,7 @@ :group 'languages) (defconst opascal-debug nil - "True if in debug mode.") + "Non-nil if in debug mode.") (define-obsolete-variable-alias 'delphi-search-path 'opascal-search-path "24.4") @@ -1732,7 +1732,8 @@ comment block. If not in a // comment, just does a normal newline." (define-obsolete-function-alias 'delphi-mode #'opascal-mode "24.4") ;;;###autoload (define-derived-mode opascal-mode prog-mode "OPascal" - "Major mode for editing OPascal code.\\ + "Major mode for editing OPascal code. +\\ \\[opascal-find-unit]\t- Search for a OPascal source file. \\[opascal-fill-comment]\t- Fill the current comment. \\[opascal-new-comment-line]\t- If in a // comment, do a new comment line. diff --git a/lisp/progmodes/prog-mode.el b/lisp/progmodes/prog-mode.el index 7f70e02b72e..6c09dcf881d 100644 --- a/lisp/progmodes/prog-mode.el +++ b/lisp/progmodes/prog-mode.el @@ -127,7 +127,7 @@ which case it will be used to compose the new symbol as per the third argument of `compose-region'.") (defun prettify-symbols-default-compose-p (start end _match) - "Return true iff the symbol MATCH should be composed. + "Return non-nil iff the symbol MATCH should be composed. The symbol starts at position START and ends at position END. This is the default for `prettify-symbols-compose-predicate' which is suitable for most programming languages such as C or Lisp." @@ -145,7 +145,7 @@ which is suitable for most programming languages such as C or Lisp." "A predicate for deciding if the currently matched symbol is to be composed. The matched symbol is the car of one entry in `prettify-symbols-alist'. The predicate receives the match's start and end positions as well -as the match-string as arguments.") +as the `match-string' as arguments.") (defun prettify-symbols--compose-symbol (alist) "Compose a sequence of characters into a symbol. diff --git a/lisp/progmodes/project.el b/lisp/progmodes/project.el index 2eead0d0696..9b63f4b1bc8 100644 --- a/lisp/progmodes/project.el +++ b/lisp/progmodes/project.el @@ -1033,8 +1033,8 @@ command \\[fileloop-continue]." (defun project-query-replace-regexp (from to) "Query-replace REGEXP in all the files of the project. Stops when a match is found and prompts for whether to replace it. -If you exit the query-replace, you can later continue the query-replace -loop using the command \\[fileloop-continue]." +If you exit the `query-replace', you can later continue the +`query-replace' loop using the command \\[fileloop-continue]." (interactive (pcase-let ((`(,from ,to) (query-replace-read-args "Query replace (regexp)" t t))) diff --git a/lisp/progmodes/verilog-mode.el b/lisp/progmodes/verilog-mode.el index d47bb8bcb96..dabf9c479e2 100644 --- a/lisp/progmodes/verilog-mode.el +++ b/lisp/progmodes/verilog-mode.el @@ -414,7 +414,7 @@ wherever possible, since it is slow." ;; "----" ["MB" nil :help "Help MB"])) (defun verilog-define-abbrev-table (tablename definitions &optional docstring &rest props) - "Filter `define-abbrev-table' TABLENAME DEFINITIONS + "Filter `define-abbrev-table' TABLENAME DEFINITIONS. Provides DOCSTRING PROPS in newer Emacs (23.1)." (condition-case nil (apply #'define-abbrev-table tablename definitions docstring props) @@ -13380,7 +13380,7 @@ Typing \\[verilog-auto] will call my-verilog-insert-hello and expand the above into: /*AUTOINSERTLISP(my-verilog-insert-hello \"world\")*/ - // Beginning of automatic insert lisp + // Beginning of automatic insert Lisp initial $write(\"hello world\"); // End of automatics diff --git a/lisp/progmodes/vhdl-mode.el b/lisp/progmodes/vhdl-mode.el index fef7dff65e2..fc0d406f73c 100644 --- a/lisp/progmodes/vhdl-mode.el +++ b/lisp/progmodes/vhdl-mode.el @@ -2197,8 +2197,8 @@ is pair matching KEY." (setq alist alist-cdr))))) (defun vhdl-aget (alist key) - "Return the value in ALIST that is associated with KEY. If KEY is -not found, then nil is returned." + "Return the value in ALIST that is associated with KEY. +If KEY is not found, then nil is returned." (cdr (assoc key alist))) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; @@ -4275,8 +4275,7 @@ STRING are replaced by `-' and substrings are converted to lower case." (defvar vhdl-sources-menu nil) (defun vhdl-directory-files (directory &optional full match) - "Call `directory-files' if DIRECTORY exists, otherwise generate error -message." + "Call `directory-files' if DIRECTORY exists, otherwise generate error message." (if (not (file-directory-p directory)) (vhdl-warning-when-idle "No such directory: \"%s\"" directory) (let ((dir (directory-files directory full match))) @@ -5734,8 +5733,8 @@ the offset is simply returned." (save-excursion (re-search-forward "\\\\" (vhdl-point 'eol) t))))) (defun vhdl-forward-comment (&optional direction) - "Skip all comments (including whitespace). Skip backwards if DIRECTION is -negative, skip forward otherwise." + "Skip all comments (including whitespace). +Skip backwards if DIRECTION is negative, skip forward otherwise." (interactive "p") (if (and direction (< direction 0)) ;; skip backwards @@ -6912,9 +6911,9 @@ previous libunit keyword)." (concat vhdl-case-alternative-re "\\|" vhdl-case-header-key)) (defun vhdl-skip-case-alternative (&optional lim) - "Skip forward over case/when bodies, with optional maximal -limit. If no next case alternative is found, nil is returned and -point is not moved." + "Skip forward over case/when bodies, with optional maximal limit. +If no next case alternative is found, nil is returned and point +is not moved." (let ((lim (or lim (point-max))) (here (point)) donep foundp) @@ -6939,9 +6938,8 @@ point is not moved." foundp)) (defun vhdl-backward-skip-label (&optional lim) - "Skip backward over a label, with optional maximal -limit. If label is not found, nil is returned and point -is not moved." + "Skip backward over a label, with optional maximal limit. +If label is not found, nil is returned and point is not moved." (let ((lim (or lim (point-min))) placeholder) (if (save-excursion @@ -6955,9 +6953,8 @@ is not moved." )) (defun vhdl-forward-skip-label (&optional lim) - "Skip forward over a label, with optional maximal -limit. If label is not found, nil is returned and point -is not moved." + "Skip forward over a label, with optional maximal limit. +If label is not found, nil is returned and point is not moved." (let ((lim (or lim (point-max)))) (if (looking-at vhdl-label-key) (progn @@ -7327,9 +7324,9 @@ after the containing paren which starts the arglist." (- ce-curcol cs-curcol -1)))) (defun vhdl-lineup-comment (_langelem) - "Support old behavior for comment indentation. We look at -vhdl-comment-only-line-offset to decide how to indent comment -only-lines." + "Support old behavior for comment indentation. +We look at `vhdl-comment-only-line-offset' to decide how to +indent comment only-lines." (save-excursion (back-to-indentation) ;; at or to the right of comment-column @@ -7445,7 +7442,7 @@ else indent `correctly'." (setq this-command 'vhdl-electric-tab))) (defun vhdl-electric-return () - "newline-and-indent or indent-new-comment-line if in comment and preceding + "`newline-and-indent' or `indent-new-comment-line' if in comment and preceding character is a space." (interactive) (if (and (= (preceding-char) ? ) (vhdl-in-comment-p)) @@ -7456,8 +7453,8 @@ character is a space." (newline-and-indent))) (defun vhdl-indent-line () - "Indent the current line as VHDL code. Returns the amount of -indentation change." + "Indent the current line as VHDL code. +Return the amount of indentation change." (interactive) (let* ((syntax (and vhdl-indent-syntax-based (vhdl-get-syntactic-context))) (pos (- (point-max) (point))) @@ -7617,8 +7614,8 @@ ALIGN-PATTERN matches the white space to be expanded/contracted.") ;; Align code (defvar vhdl-align-try-all-clauses t - "If REGEXP is not found on the first line of the region that clause -is ignored. If this variable is non-nil, then the clause is tried anyway.") + "If REGEXP is not found on the first line of the region that clause is ignored. +If this variable is non-nil, then the clause is tried anyway.") (defun vhdl-do-group (function &optional spacing) "Apply FUNCTION on group of lines between empty lines." @@ -7637,8 +7634,7 @@ is ignored. If this variable is non-nil, then the clause is tried anyway.") (funcall function beg end spacing))) (defun vhdl-do-list (function &optional spacing) - "Apply FUNCTION to the lines of a list surrounded by a balanced group of -parentheses." + "Apply FUNCTION to lines of a list surrounded by a balanced group of parentheses." (let (beg end) (save-excursion ;; search for beginning of balanced group of parentheses @@ -7683,11 +7679,11 @@ parentheses." (funcall function beg end spacing))) (defun vhdl-align-region-1 (begin end &optional spacing alignment-list _indent) - "Attempt to align a range of lines based on the content of the -lines. The definition of `alignment-list' determines the matching -order and the manner in which the lines are aligned. If ALIGNMENT-LIST -is not specified `vhdl-align-alist' is used. If INDENT is non-nil, -indentation is done before aligning." + "Attempt to align a range of lines based on the content of the lines. +The definition of `alignment-list' determines the matching order +and the manner in which the lines are aligned. If ALIGNMENT-LIST +is not specified `vhdl-align-alist' is used. If INDENT is +non-nil, indentation is done before aligning." (interactive "r\np") (setq alignment-list (or alignment-list vhdl-align-alist)) (setq spacing (or spacing 1)) @@ -11070,7 +11066,7 @@ Point is left between them." ;; Help functions (defun vhdl-electric-space (count) - "Expand abbreviations and self-insert space(s), do indent-new-comment-line + "Expand abbreviations and self-insert space(s), do `indent-new-comment-line' if in comment and past end-comment-column." (interactive "p") (cond ((vhdl-in-comment-p) @@ -11619,8 +11615,7 @@ but not if inside a comment or quote." string))) (defun vhdl-paste-group-comment (string indent) - "Paste comment and empty lines from STRING between groups of lines -with INDENT." + "Paste comment and empty lines from STRING between groups of lines with INDENT." (let ((pos (point-marker))) (when (> indent 0) (while (string-match "^\\(--\\)" string) @@ -14919,7 +14914,8 @@ if required." (setq project-alist (cdr project-alist))))) (defun vhdl-speedbar-insert-project-hierarchy (project indent &optional rescan) - "Insert hierarchy of PROJECT. Rescan directories if RESCAN is non-nil, + "Insert hierarchy of PROJECT. +Rescan directories if optional argument RESCAN is non-nil, otherwise use cached data." (when (or rescan (and (not (assoc project vhdl-file-alist)) (not (vhdl-load-cache project)))) @@ -14937,7 +14933,8 @@ otherwise use cached data." (vhdl-speedbar-expand-units project)) (defun vhdl-speedbar-insert-dir-hierarchy (directory depth &optional rescan) - "Insert hierarchy of DIRECTORY. Rescan directory if RESCAN is non-nil, + "Insert hierarchy of DIRECTORY. +Rescan directory if optional argument RESCAN is non-nil, otherwise use cached data." (when (or rescan (and (not (assoc directory vhdl-file-alist)) (not (vhdl-load-cache directory)))) diff --git a/lisp/progmodes/xref.el b/lisp/progmodes/xref.el index 69cabd0b5a5..772e6646d95 100644 --- a/lisp/progmodes/xref.el +++ b/lisp/progmodes/xref.el @@ -760,7 +760,7 @@ references displayed in the current *xref* buffer." (defun xref--outdated-p (item) "Check that the match location at current position is up-to-date. -ITEMS is an xref item which " +ITEMS is an xref item which " ; FIXME: Expand documentation. ;; FIXME: The check should most likely be a generic function instead ;; of the assumption that all matches' summaries relate to the ;; buffer text in a particular way. diff --git a/lisp/rect.el b/lisp/rect.el index 504be41b673..d288adfbaf6 100644 --- a/lisp/rect.el +++ b/lisp/rect.el @@ -202,8 +202,8 @@ rectangles, as conses of the form (WIDTH . HEIGHT)." (<= (+ y2 h2) y1))))) (defun rectangle-dimensions (start end) - "Return the dimensions of the rectangle with corners at START -and END. The returned value has the form of (WIDTH . HEIGHT)." + "Return the dimensions of the rectangle with corners at START and END. +The returned value has the form of (WIDTH . HEIGHT)." (save-excursion (let* ((height (1+ (abs (- (line-number-at-pos end) (line-number-at-pos start))))) diff --git a/lisp/repeat.el b/lisp/repeat.el index 0b761fff1e3..ee9e14b5155 100644 --- a/lisp/repeat.el +++ b/lisp/repeat.el @@ -218,7 +218,7 @@ recently executed command not bound to an input event\"." ((null last-repeatable-command) (error "There is nothing to repeat")) ((eq last-repeatable-command 'mode-exit) - (error "last-repeatable-command is mode-exit & can't be repeated")) + (error "`last-repeatable-command' is `mode-exit' and can't be repeated")) ((memq last-repeatable-command repeat-too-dangerous) (error "Command %S too dangerous to repeat automatically" last-repeatable-command))) diff --git a/lisp/replace.el b/lisp/replace.el index e4155d4c27a..84ec042f455 100644 --- a/lisp/replace.el +++ b/lisp/replace.el @@ -63,7 +63,7 @@ it will match any sequence matched by the regexp `search-whitespace-regexp'." :version "24.3") (defvar query-replace-history nil - "Default history list for query-replace commands. + "Default history list for `query-replace' commands. See `query-replace-from-history-variable' and `query-replace-to-history-variable'.") @@ -202,7 +202,7 @@ by this function to the end of values available via (car (symbol-value query-replace-from-history-variable))))) (defun query-replace-read-from (prompt regexp-flag) - "Query and return the `from' argument of a query-replace operation. + "Query and return the `from' argument of a `query-replace' operation. Prompt with PROMPT. REGEXP-FLAG non-nil means the response should be a regexp. The return value can also be a pair (FROM . TO) indicating that the user wants to replace FROM with TO." @@ -326,8 +326,9 @@ the original string if not." (defun query-replace-read-to (from prompt regexp-flag) - "Query and return the `to' argument of a query-replace operation. -Prompt with PROMPT. REGEXP-FLAG non-nil means the response should a regexp." + "Query and return the `to' argument of a `query-replace' operation. +Prompt with PROMPT. REGEXP-FLAG non-nil means the response +should a regexp." (query-replace-compile-replacement (save-excursion (let* ((history-add-new-input nil) @@ -1300,7 +1301,7 @@ See `occur-revert-function'.") (defcustom occur-mode-find-occurrence-hook nil "Hook run by Occur after locating an occurrence. This will be called with the cursor position at the occurrence. An application -for this is to reveal context in an outline-mode when the occurrence is hidden." +for this is to reveal context in an outline mode when the occurrence is hidden." :type 'hook :group 'matching) @@ -2606,7 +2607,7 @@ passed in. If LITERAL is set, no checking is done, anyway." noedit) (defvar replace-update-post-hook nil - "Function(s) to call after query-replace has found a match in the buffer.") + "Function(s) to call after `query-replace' has found a match in the buffer.") (defvar replace-search-function nil "Function to use when searching for strings to replace. diff --git a/lisp/ruler-mode.el b/lisp/ruler-mode.el index a0d4f6e96c2..84c9d06ecec 100644 --- a/lisp/ruler-mode.el +++ b/lisp/ruler-mode.el @@ -348,7 +348,7 @@ nothing is dragged.") (defun ruler-mode-text-scaled-width (width) "Compute scaled text width according to current font scaling. Convert a width of char units into a text-scaled char width units, -Ex. `window-hscroll'." +for example `window-hscroll'." (/ (* width (frame-char-width)) (default-font-width))) (defun ruler-mode-text-scaled-window-hscroll () diff --git a/lisp/server.el b/lisp/server.el index 5dd30db195a..6359a761994 100644 --- a/lisp/server.el +++ b/lisp/server.el @@ -1078,7 +1078,7 @@ The following commands are accepted by the client: `-suspend' Suspend this terminal, i.e., stop the client process. - Sent when the user presses C-z." + Sent when the user presses \\[suspend-frame]." (server-log (concat "Received " string) proc) ;; First things first: let's check the authentication (unless (process-get proc :authenticated) diff --git a/lisp/ses.el b/lisp/ses.el index 9250f7ede0f..ea966295b18 100644 --- a/lisp/ses.el +++ b/lisp/ses.el @@ -299,11 +299,11 @@ Used for listing local printers or renamed cells.") ses-center-span ses-dashfill ses-dashfill-span ses-tildefill-span ses-prin1) - "List of print functions to be included in initial history of -printer functions. None of these standard-printer functions, -except function `ses-prin1', is suitable for use as a column -printer or a global-default printer because they invoke the -column or default printer and then modify its output.") + "List of print functions to be included in initial history of printer functions. +None of these standard-printer functions, except function +`ses-prin1', is suitable for use as a column printer or a +global-default printer because they invoke the column or default +printer and then modify its output.") ;;---------------------------------------------------------------------------- diff --git a/lisp/shell.el b/lisp/shell.el index 5cdc0385a6f..b575024e016 100644 --- a/lisp/shell.el +++ b/lisp/shell.el @@ -517,7 +517,8 @@ Shell buffers. It implements `shell-completion-execonly' for (put 'shell-mode 'mode-class 'special) (define-derived-mode shell-mode comint-mode "Shell" - "Major mode for interacting with an inferior shell.\\ + "Major mode for interacting with an inferior shell. +\\ \\[comint-send-input] after the end of the process' output sends the text from the end of process to the end of the current line. \\[comint-send-input] before end of process output copies the current line minus the prompt to diff --git a/lisp/simple.el b/lisp/simple.el index 1267c92fe54..298e3ea5ee0 100644 --- a/lisp/simple.el +++ b/lisp/simple.el @@ -241,7 +241,7 @@ all other buffers." (defun next-error-buffer-on-selected-frame (&optional _avoid-current extra-test-inclusive extra-test-exclusive) - "Return a single visible next-error buffer on the selected frame." + "Return a single visible `next-error' buffer on the selected frame." (let ((window-buffers (delete-dups (delq nil (mapcar (lambda (w) @@ -2133,21 +2133,23 @@ or (if one of MODES is a minor mode), if it is switched on in BUFFER." command-names))) (defcustom suggest-key-bindings t - "Non-nil means show the equivalent key-binding when M-x command has one. + "Non-nil means show the equivalent keybinding when \ +\\[execute-extended-command] has one. The value can be a length of time to show the message for. If the value is non-nil and not a number, we wait 2 seconds. Also see `extended-command-suggest-shorter'. Equivalent key-bindings are also shown in the completion list of -M-x for all commands that have them." +\\[execute-extended-command] for all commands that have them." :group 'keyboard :type '(choice (const :tag "off" nil) (integer :tag "time" 2) (other :tag "on"))) (defcustom extended-command-suggest-shorter t - "If non-nil, show a shorter M-x invocation when there is one. + "If non-nil, show a shorter \\[execute-extended-command] invocation \ +when there is one. Also see `suggest-key-bindings'." :group 'keyboard @@ -3522,7 +3524,7 @@ with < or <= based on USE-<." ;; called or in some cases on a timer called after a change is made in ;; any buffer. (defvar-local undo-auto--last-boundary-cause nil - "Describe the cause of the last undo-boundary. + "Describe the cause of the last `undo-boundary'. If `explicit', the last boundary was caused by an explicit call to `undo-boundary', that is one not called by the code in this @@ -9817,11 +9819,13 @@ warning using STRING as the message.") The argument `COMMAND' should be a symbol. -Running `M-x COMMAND RET' for the first time prompts for which +Running `\\[execute-extended-command] COMMAND RET' for \ +the first time prompts for which alternative to use and records the selected command as a custom variable. -Running `C-u M-x COMMAND RET' prompts again for an alternative +Running `\\[universal-argument] \\[execute-extended-command] COMMAND RET' \ +prompts again for an alternative and overwrites the previous choice. The variable `COMMAND-alternatives' contains an alist with diff --git a/lisp/so-long.el b/lisp/so-long.el index 65570bf253d..c975384ddb3 100644 --- a/lisp/so-long.el +++ b/lisp/so-long.el @@ -492,7 +492,7 @@ ;; considered internal-use only (with `global-so-long-mode' the interface ;; for enabling or disabling the automated behaviour). FIXME: Establish a ;; way to support the original use-case, or rename to `so-long--enabled'. - "Internal use. Non-nil when any so-long functionality has been used.") + "Internal use. Non-nil when any `so-long' functionality has been used.") (defvar-local so-long--active nil ; internal use "Non-nil when `so-long' mitigations are in effect.") @@ -1100,7 +1100,7 @@ This command calls `so-long' with the selected action as an argument.") ;;;###autoload (defun so-long-commentary () - "View the so-long library's documentation in `outline-mode'." + "View the `so-long' library's documentation in `outline-mode'." (interactive) (let ((buf "*So Long: Commentary*")) (when (buffer-live-p (get-buffer buf)) @@ -1862,14 +1862,14 @@ invoked." ;;;###autoload (defun so-long-enable () - "Enable the so-long library's functionality. + "Enable the `so-long' library's functionality. Equivalent to calling (global-so-long-mode 1)" (interactive) (global-so-long-mode 1)) (defun so-long-disable () - "Disable the so-long library's functionality. + "Disable the `so-long' library's functionality. Equivalent to calling (global-so-long-mode 0)" (interactive) diff --git a/lisp/sort.el b/lisp/sort.el index be373fba99b..d6767ed5098 100644 --- a/lisp/sort.el +++ b/lisp/sort.el @@ -507,7 +507,8 @@ Use \\[untabify] to convert tabs to spaces before sorting." (setq col-start (min col-beg1 col-end1)) (setq col-end (max col-beg1 col-end1)) (if (search-backward "\t" beg1 t) - (error "sort-columns does not work with tabs -- use M-x untabify")) + (error (substitute-command-keys + "sort-columns does not work with tabs -- use \\[untabify]"))) (if (not (or (memq system-type '(windows-nt)) (let ((pos beg1) plist fontified) (catch 'found diff --git a/lisp/subr.el b/lisp/subr.el index 0793cbca5e1..a6434bf28a8 100644 --- a/lisp/subr.el +++ b/lisp/subr.el @@ -22,6 +22,8 @@ ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs. If not, see . +;;; Commentary: + ;;; Code: ;; declare-function's args use &rest, not &optional, for compatibility diff --git a/lisp/tempo.el b/lisp/tempo.el index 25f54af3c9d..b722cc04ca2 100644 --- a/lisp/tempo.el +++ b/lisp/tempo.el @@ -445,7 +445,7 @@ never prompted." ;;; tempo-is-user-element (defun tempo-is-user-element (element) - "Tries all the user-defined element handlers in `tempo-user-elements'." + "Try all the user-defined element handlers in `tempo-user-elements'." ;; Sigh... I need (some list) (catch 'found (mapc (lambda (handler) diff --git a/lisp/term.el b/lisp/term.el index d3d02188573..af930891043 100644 --- a/lisp/term.el +++ b/lisp/term.el @@ -340,7 +340,7 @@ (defvar term-home-marker) ; Marks the "home" position for cursor addressing. (defvar term-saved-home-marker nil "When using alternate sub-buffer, -contains saved term-home-marker from original sub-buffer.") +contains saved `term-home-marker' from original sub-buffer.") (defvar term-start-line-column 0 "(current-column) at start of screen line, or nil if unknown.") (defvar term-current-column 0 "If non-nil, is cache for (current-column).") @@ -377,7 +377,7 @@ are not allowed.") (defvar term-scroll-with-delete nil "If t, forward scrolling should be implemented by delete to top-most line(s); and if nil, scrolling should be implemented -by moving term-home-marker. It is set to t if there is a +by moving `term-home-marker'. It is set to t if there is a \(non-default) scroll-region OR the alternate buffer is used.") (defvar term-pending-delete-marker) ; New user input in line mode ; needs to be deleted, because it gets echoed by the inferior. @@ -669,7 +669,7 @@ Do not change it directly; use `term-set-escape-char' instead.") "Keymap used in Term pager mode.") (defvar term-ptyp t - "True if communications via pty; false if by pipe. Buffer local. + "Non-nil if communications via pty; false if by pipe. Buffer local. This is to work around a bug in Emacs process signaling.") (defvar term-last-input-match "" @@ -1228,8 +1228,7 @@ Entry to this mode runs the hooks on `term-mode-hook'." (process-send-string proc chars)))) (defun term-send-raw () - "Send the last character typed through the terminal-emulator -without any interpretation." + "Send last typed character to the terminal-emulator without any interpretation." (interactive) (let ((keys (this-command-keys))) (term-send-raw-string (string (aref keys (1- (length keys))))))) @@ -1401,8 +1400,8 @@ Called as a buffer-local `read-only-mode-hook' function." (force-mode-line-update)) (defun term-check-proc (buffer) - "True if there is a process associated w/buffer BUFFER, and it -is alive. BUFFER can be either a buffer or the name of one." + "Non-nil if there is a process associated w/buffer BUFFER, and it is alive. +BUFFER can be either a buffer or the name of one." (let ((proc (get-buffer-process buffer))) (and proc (memq (process-status proc) '(run stop open listen connect))))) @@ -1538,7 +1537,7 @@ Using \"emacs\" loses, because bash disables editing if $TERM == emacs.") Some other integer if Bash is new or not in use. Nil if unknown.") (defun term--bash-needs-EMACSp () - "t if Bash is old, nil if it is new or not in use." + "Return t if Bash is old, nil if it is new or not in use." (eq 43 (or term--bash-needs-EMACS-status (setf @@ -2107,17 +2106,17 @@ The values of `term-get-old-input', `term-input-filter-functions', and in the buffer. E.g., If the interpreter is the csh, - term-get-old-input is the default: take the current line, discard any - initial string matching regexp term-prompt-regexp. - term-input-filter-functions monitors input for \"cd\", \"pushd\", and + `term-get-old-input' is the default: take the current line, discard any + initial string matching regexp `term-prompt-regexp'. + `term-input-filter-functions' monitors input for \"cd\", \"pushd\", and \"popd\" commands. When it sees one, it cd's the buffer. - term-input-filter is the default: returns t if the input isn't all white + `term-input-filter' is the default: returns t if the input isn't all white space. If the term is Lucid Common Lisp, - term-get-old-input snarfs the sexp ending at point. - term-input-filter-functions does nothing. - term-input-filter returns nil if the input matches input-filter-regexp, + `term-get-old-input' snarfs the sexp ending at point. + `term-input-filter-functions' does nothing. + `term-input-filter' returns nil if the input matches input-filter-regexp, which matches (1) all whitespace (2) :a, :c, etc. Similarly for Soar, Scheme, etc." @@ -2403,8 +2402,7 @@ Useful if you accidentally suspend the top-level process." (kill-region pmark (point))))) (defun term-delchar-or-maybe-eof (arg) - "Delete ARG characters forward, or send an EOF to process if at end of -buffer." + "Delete ARG characters forward, or send an EOF to process if at end of buffer." (interactive "p") (if (eobp) (process-send-eof) @@ -3171,7 +3169,7 @@ See `term-prompt-regexp'." Set in `pre-command-hook' in char mode by `term-set-goto-process-mark'.") (defun term-set-goto-process-mark () - "Sets `term-goto-process-mark'. + "Set `term-goto-process-mark'. Always set to nil if `term-char-mode-point-at-process-mark' is nil. @@ -3430,7 +3428,7 @@ option is enabled. See `term-set-goto-process-mark'." (t))) (defun term--reset-scroll-region () - "Sets the scroll region to the full height of the terminal." + "Set the scroll region to the full height of the terminal." (term-set-scroll-region 0 (term--last-line))) (defun term-set-scroll-region (top bottom) @@ -3793,7 +3791,7 @@ all pending output has been dealt with.")) (defun term-erase-in-display (kind) "Erase (that is blank out) part of the window. -If KIND is 0, erase from (point) to (point-max); +If KIND is 0, erase from point to point-max; if KIND is 1, erase from home to point; else erase from home to point-max." (term-handle-deferred-scroll) (cond ((eq kind 0) diff --git a/lisp/textmodes/bib-mode.el b/lisp/textmodes/bib-mode.el index e2fd3ecaa42..a429aae7f70 100644 --- a/lisp/textmodes/bib-mode.el +++ b/lisp/textmodes/bib-mode.el @@ -137,7 +137,7 @@ with the cdr.") (defcustom bib-auto-capitalize t - "True to automatically capitalize appropriate fields in Bib mode." + "Non-nil to automatically capitalize appropriate fields in Bib mode." :type 'boolean) (defconst bib-capitalized-fields "%[AETCBIJR]") diff --git a/lisp/textmodes/flyspell.el b/lisp/textmodes/flyspell.el index 9b3211df57a..1d450b50012 100644 --- a/lisp/textmodes/flyspell.el +++ b/lisp/textmodes/flyspell.el @@ -1861,7 +1861,7 @@ is itself incorrect, but suspiciously repeated." ;;* flyspell-highlight-duplicate-region ... */ ;;*---------------------------------------------------------------------*/ (defun flyspell-highlight-duplicate-region (beg end poss) - "Set up an overlay on a duplicate misspelled word, in the buffer from BEG to END. + "Set up overlay on duplicate misspelled word, in the buffer from BEG to END. POSS is a list of possible spelling/correction lists, as returned by `ispell-parse-output'." (let ((inhibit-read-only t)) diff --git a/lisp/textmodes/makeinfo.el b/lisp/textmodes/makeinfo.el index 13367a09bcf..6b9b3f3e9de 100644 --- a/lisp/textmodes/makeinfo.el +++ b/lisp/textmodes/makeinfo.el @@ -175,10 +175,9 @@ command to gain use of `next-error'." 'makeinfo-compilation-sentinel-region))))))) (defun makeinfo-next-error (_arg _reset) - "This function is used to disable `next-error' if the user has -used `makeinfo-region'. Since the compilation process is used on -a temporary file in that case, calling `next-error' would give -nonsensical results." + "This is used to disable `next-error' if the user has used `makeinfo-region'. +Since the compilation process is used on a temporary file in that +case, calling `next-error' would give nonsensical results." (error "Use `makeinfo-buffer' to gain use of the `next-error' command")) ;; Actually run makeinfo. COMMAND is the command to run. If diff --git a/lisp/textmodes/mhtml-mode.el b/lisp/textmodes/mhtml-mode.el index 25905385685..936732153ae 100644 --- a/lisp/textmodes/mhtml-mode.el +++ b/lisp/textmodes/mhtml-mode.el @@ -19,6 +19,8 @@ ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs. If not, see . +;;; Commentary: + ;;; Code: (eval-when-compile (require 'cl-lib)) diff --git a/lisp/textmodes/refill.el b/lisp/textmodes/refill.el index 0a0e4cc444c..b2ebbd5f375 100644 --- a/lisp/textmodes/refill.el +++ b/lisp/textmodes/refill.el @@ -153,7 +153,7 @@ regardless of the number of after-change calls from commands doing complex processing.") (defun refill-after-change-function (_beg end _len) - "Function for `after-change-functions' which just sets `refill-doit'." + "Set `refill-doit'. Used by `after-change-functions'." (unless undo-in-progress (setq refill-doit end))) diff --git a/lisp/textmodes/reftex-dcr.el b/lisp/textmodes/reftex-dcr.el index abcf119fb82..ee26d911a5d 100644 --- a/lisp/textmodes/reftex-dcr.el +++ b/lisp/textmodes/reftex-dcr.el @@ -32,14 +32,17 @@ ;;;###autoload (defun reftex-view-crossref (&optional arg auto-how fail-quietly) - "View cross reference of macro at point. Point must be on the KEY -argument. When at a `\\ref' macro, show corresponding `\\label' -definition, also in external documents (`xr'). When on a label, show -a locations where KEY is referenced. Subsequent calls find additional -locations. When on a `\\cite', show the associated `\\bibitem' macro or -the BibTeX database entry. When on a `\\bibitem', show a `\\cite' macro -which uses this KEY. When on an `\\index', show other locations marked -by the same index entry. + "View cross reference of macro at point. + +Point must be on the KEY argument. When at a `\\ref' macro, show +corresponding `\\label' definition, also in external +documents (`xr'). When on a label, show a locations where KEY is +referenced. Subsequent calls find additional locations. When on +a `\\cite', show the associated `\\bibitem' macro or the BibTeX +database entry. When on a `\\bibitem', show a `\\cite' macro +which uses this KEY. When on an `\\index', show other locations +marked by the same index entry. + To define additional cross referencing items, use the option `reftex-view-crossref-extra'. See also `reftex-view-crossref-from-bibtex'. With one or two \\[universal-argument] prefixes, enforce rescanning of the document. diff --git a/lisp/textmodes/reftex-global.el b/lisp/textmodes/reftex-global.el index 3b7518e5c3f..cc8b3244b99 100644 --- a/lisp/textmodes/reftex-global.el +++ b/lisp/textmodes/reftex-global.el @@ -338,17 +338,17 @@ Also checks if buffers visiting the files are in read-only mode." (while (setq file (pop files)) (unless (file-exists-p file) (ding) - (or (y-or-n-p (format "No such file %s. Continue? " file)) + (or (y-or-n-p (format "No such file %s. Continue?" file)) (error "Abort"))) (unless (file-writable-p file) (ding) - (or (y-or-n-p (format "No write access to %s. Continue? " file)) + (or (y-or-n-p (format "No write access to %s. Continue?" file)) (error "Abort"))) (when (and (setq buf (find-buffer-visiting file)) (with-current-buffer buf buffer-read-only)) (ding) - (or (y-or-n-p (format "Buffer %s is read-only. Continue? " + (or (y-or-n-p (format "Buffer %s is read-only. Continue?" (buffer-name buf))) (error "Abort")))))) diff --git a/lisp/textmodes/reftex-index.el b/lisp/textmodes/reftex-index.el index 423c5398dd6..9d9eab4d7b5 100644 --- a/lisp/textmodes/reftex-index.el +++ b/lisp/textmodes/reftex-index.el @@ -934,8 +934,8 @@ When index is restricted, select the previous section as restriction criterion." (t nil)))) (defun reftex-index-analyze-entry (data) - ;; This splits the index context so that key, attribute and visual - ;; values are accessible individually. + "Split index context so that key, attribute and visual +values are accessible individually." (interactive) (let* ((arg (nth 5 data)) (context (nth 2 data)) diff --git a/lisp/textmodes/reftex-parse.el b/lisp/textmodes/reftex-parse.el index 9def10cee05..c521a07f192 100644 --- a/lisp/textmodes/reftex-parse.el +++ b/lisp/textmodes/reftex-parse.el @@ -435,7 +435,8 @@ This function also makes sure the old toc markers do not point anywhere." ;;;###autoload (defun reftex-section-info (file) "Return a section entry for the current match. -Careful: This function expects the match-data to be still in place!" +Careful: This function expects the `match-data' to still be in +place!" (let* ((marker (set-marker (make-marker) (1- (match-beginning 3)))) (macro (reftex-match-string 3)) (prefix (save-match-data @@ -494,7 +495,8 @@ will rescan the entire document." ;;;###autoload (defun reftex-index-info (file) "Return an index entry for the current match. -Careful: This function expects the match-data to be still in place!" +Careful: This function expects the `match-data' to still be in +place!" (catch 'exit (let* ((macro (reftex-match-string 10)) (bom (match-beginning 10)) diff --git a/lisp/textmodes/reftex-vars.el b/lisp/textmodes/reftex-vars.el index 23f2193501d..d57a7678553 100644 --- a/lisp/textmodes/reftex-vars.el +++ b/lisp/textmodes/reftex-vars.el @@ -330,7 +330,8 @@ select the nearest entry with the correct new level." "The maximum level of toc entries which will be included in the TOC. Section headings with a bigger level will be ignored. In RefTeX, chapters are level 1, sections are level 2 etc. -This variable can be changed from within the *toc* buffer with the `t' key." +This variable can be changed from within the *toc* buffer with \ +\\\\[reftex-toc-max-level]." :group 'reftex-table-of-contents-browser :type 'integer) @@ -1208,7 +1209,7 @@ path." :type '(repeat (file))) (defcustom reftex-sort-bibtex-matches 'reverse-year - "Sorting of the entries found in BibTeX databases by reftex-citation. + "Sorting of the entries found in BibTeX databases by `reftex-citation'. Possible values: nil Do not sort entries. `author' Sort entries by author name. @@ -1364,7 +1365,7 @@ should return the string to insert into the buffer." :type '(choice (const nil) function)) (defcustom reftex-select-bib-mode-hook nil - "Mode hook for reftex-select-bib-mode." + "Mode hook for `reftex-select-bib-mode'." :group 'reftex-citation-support :type 'hook) @@ -1840,7 +1841,7 @@ upon the variable `reftex-initialize-temporary-buffers'." (defcustom reftex-initialize-temporary-buffers nil "Non-nil means do initializations even when visiting file temporarily. -When nil, RefTeX may turn off find-file hooks and other stuff to briefly +When nil, RefTeX may turn off `find-file' hooks and other stuff to briefly visit a file. When t, the full default initializations are done (find-file-hook etc.). Instead of t or nil, this variable may also be a list of hook functions to diff --git a/lisp/textmodes/texinfmt.el b/lisp/textmodes/texinfmt.el index 604a67df323..550994cd7b6 100644 --- a/lisp/textmodes/texinfmt.el +++ b/lisp/textmodes/texinfmt.el @@ -932,9 +932,9 @@ commands." "Text of the copyright notice and copying permissions.") (defun texinfo-copying () - "Copy the copyright notice and copying permissions from the Texinfo file, -as indicated by the @copying ... @end copying command; -insert the text with the @insertcopying command." + "Copy the copyright notice and copying permissions from Texinfo file. +This is indicated by the \"@copying ... @end copying\" command; +insert the text with the \"@insertcopying\" command." (let ((beg (progn (beginning-of-line) (point))) (end (progn (re-search-forward "^@end copying[ \t]*\n") (point)))) (setq texinfo-copying-text @@ -944,8 +944,8 @@ insert the text with the @insertcopying command." (delete-region beg end))) (defun texinfo-insertcopying () - "Insert the copyright notice and copying permissions from the Texinfo file, -which are indicated by the @copying ... @end copying command." + "Insert the copyright notice and copying permissions from Texinfo file. +This is indicated by the \"@copying ... @end copying\" command." (insert (concat "\n" texinfo-copying-text))) (put 'begin 'texinfo-format 'texinfo-format-begin) @@ -2546,7 +2546,9 @@ If used within a line, follow `@bullet' with braces." "smalllisp" "\\)") "Regexp specifying end of environments in which @kbd does not put `...' -around argument. (See `texinfo-format-kbd-regexp')") +around argument. + +See `texinfo-format-kbd-regexp'.") (put 'kbd 'texinfo-format 'texinfo-format-kbd) (defun texinfo-format-kbd () diff --git a/lisp/transient.el b/lisp/transient.el index 2be82f56d86..f3d3902a77e 100644 --- a/lisp/transient.el +++ b/lisp/transient.el @@ -1289,8 +1289,8 @@ variable instead.") (defvar transient--exitp nil "Whether to exit the transient.") (defvar transient--showp nil "Whether the transient is show in a popup buffer.") -(defvar transient--helpp nil "Whether help-mode is active.") -(defvar transient--editp nil "Whether edit-mode is active.") +(defvar transient--helpp nil "Whether `help-mode' is active.") +(defvar transient--editp nil "Whether `edit-mode' is active.") (defvar transient--active-infix nil "The active infix awaiting user input.") diff --git a/lisp/wdired.el b/lisp/wdired.el index eafb50cc18a..eb5a6385563 100644 --- a/lisp/wdired.el +++ b/lisp/wdired.el @@ -453,7 +453,7 @@ non-nil means return old filename." (remove-function (local 'revert-buffer-function) #'wdired-revert)) (defun wdired-abort-changes () - "Abort changes and return to dired mode." + "Abort changes and return to `dired-mode'." (interactive) (remove-hook 'before-change-functions #'wdired--before-change-fn t) (let ((inhibit-read-only t)) @@ -689,7 +689,7 @@ Optional arguments are ignored." ;; FIXME: Can't we use the normal mechanism for that? --Stef (if (and (buffer-modified-p) - (not (y-or-n-p "Buffer changed. Discard changes and kill buffer?"))) + (not (y-or-n-p "Buffer changed. Discard changes and kill buffer?"))) (error "Error"))) ;; Added to after-change-functions in wdired-change-to-wdired-mode to diff --git a/lisp/whitespace.el b/lisp/whitespace.el index 59d3249c5de..e193be6cdd2 100644 --- a/lisp/whitespace.el +++ b/lisp/whitespace.el @@ -565,8 +565,8 @@ Used when `whitespace-style' includes the value `space-before-tab'.") (defvar whitespace-indentation 'whitespace-indentation - "Symbol face used to visualize `tab-width' or more SPACEs at beginning of -line. Used when `whitespace-style' includes the value `indentation'.") + "Symbol face used to visualize `tab-width' or more SPACEs at beginning of line. +Used when `whitespace-style' includes the value `indentation'.") (make-obsolete-variable 'whitespace-indentation "use the face instead." "24.4") (defface whitespace-indentation @@ -2353,7 +2353,7 @@ Also refontify when necessary." (defun whitespace-display-vector-p (vec) - "Return true if every character in vector VEC can be displayed." + "Return non-nil if every character in vector VEC can be displayed." (let ((i (length vec))) (when (> i 0) (while (and (>= (setq i (1- i)) 0) diff --git a/lisp/wid-edit.el b/lisp/wid-edit.el index 9a34dc8d438..ab358da7e3f 100644 --- a/lisp/wid-edit.el +++ b/lisp/wid-edit.el @@ -190,7 +190,7 @@ the contents of strings." (buffer-enable-undo)) (defcustom widget-menu-max-size 40 - "Largest number of items allowed in a popup-menu. + "Largest number of items allowed in a popup menu. Larger menus are read through the minibuffer." :group 'widgets :type 'integer) @@ -202,9 +202,8 @@ For a larger number of items, the minibuffer is used." :type 'integer) (defcustom widget-menu-minibuffer-flag nil - "Control how to ask for a choice from the keyboard. -Non-nil means use the minibuffer; -nil means read a single character." + "Non-nil means use the minibuffer; to ask for a choice from the keyboard. +If nil, read a single character." :group 'widgets :type 'boolean) diff --git a/lisp/woman.el b/lisp/woman.el index fe9f8969c3e..1ca4d5e8716 100644 --- a/lisp/woman.el +++ b/lisp/woman.el @@ -1790,7 +1790,7 @@ Argument EVENT is the invoking mouse event." ;; That comment was moved after the symbol `woman-menu' to make ;; find-function-search-for-symbol work. -- rost woman-mode-map - "WoMan Menu" + "WoMan Menu." `("WoMan" ["WoMan..." woman t] ; [NAME CALLBACK ENABLE] "--" @@ -2182,7 +2182,7 @@ To be called on original buffer and any .so insertions." ;; variable. zsoelim is always run as the very first preprocessor. (defvar woman-emulate-tbl nil - "True if WoMan should emulate the tbl preprocessor. + "Non-nil 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.") -- cgit v1.2.3 From 0da8118dcbf3c54dd6ecc9c0e3314a56ca82ec51 Mon Sep 17 00:00:00 2001 From: Stefan Kangas Date: Fri, 24 Sep 2021 20:59:32 +0200 Subject: Use command substitution instead of raw keys in more places * admin/authors.el (authors): * lisp/abbrev.el (abbrev-suggest-show-report): * lisp/calc/calc.el (calc-display-trail, calc): * lisp/completion.el (completion-locate-db-error): * lisp/dired-x.el (dired-extra-startup): * lisp/emacs-lisp/package.el (package-install-selected-packages): * lisp/emulation/viper.el (viper-mode): * lisp/facemenu.el (list-colors-display): * lisp/mail/emacsbug.el (report-emacs-bug-hook): * lisp/mail/sendmail.el (mail): * lisp/menu-bar.el (menu-bar-mode): * lisp/org/org.el (org-revert-all-org-buffers): * lisp/progmodes/antlr-mode.el (antlr-help-rules-intro) (antlr-insert-makefile-rules): * lisp/progmodes/gdb-mi.el (gdb--check-interpreter): * lisp/progmodes/xscheme.el (xscheme-process-sentinel): * lisp/ps-print.el (ps-font-info-database): * lisp/recentf.el (recentf-edit-list, recentf-open-files): * lisp/vc/ediff-util.el (ediff-suspend): * lisp/vc/pcvs.el (cvs-mode): * lisp/vc/vc-bzr.el (vc-bzr-dir-extra-headers): Use command substitution. --- admin/authors.el | 3 ++- lisp/abbrev.el | 4 ++-- lisp/calc/calc.el | 6 ++++-- lisp/completion.el | 3 ++- lisp/dired-x.el | 2 +- lisp/emacs-lisp/package.el | 4 +++- lisp/emulation/viper.el | 2 +- lisp/facemenu.el | 7 ++++--- lisp/mail/emacsbug.el | 2 +- lisp/mail/sendmail.el | 3 ++- lisp/menu-bar.el | 4 +++- lisp/org/org.el | 4 ++-- lisp/progmodes/antlr-mode.el | 5 +++-- lisp/progmodes/gdb-mi.el | 4 +++- lisp/progmodes/xscheme.el | 4 ++-- lisp/ps-print.el | 2 +- lisp/recentf.el | 8 +++++--- lisp/vc/ediff-util.el | 4 ++-- lisp/vc/pcvs.el | 3 ++- lisp/vc/vc-bzr.el | 3 ++- 20 files changed, 47 insertions(+), 30 deletions(-) (limited to 'lisp/progmodes/gdb-mi.el') diff --git a/admin/authors.el b/admin/authors.el index 3dec23c1916..fd46dabaa3a 100644 --- a/admin/authors.el +++ b/admin/authors.el @@ -1610,7 +1610,8 @@ and a buffer *Authors Errors* containing references to unknown files." ;; the versioned ChangeLog.N rather than the unversioned ChangeLog. (zerop (call-process "make" nil nil nil "-C" root "change-history-nocommit")) - (error "Problem updating ChangeLog, try \"C-u M-x authors RET\"")) + (error (substitute-command-keys + "Problem updating ChangeLog, try \"\\[universal-argument] \\[authors]\""))) (let ((logs (process-lines find-program root "-name" "ChangeLog*")) (table (make-hash-table :test 'equal)) (buffer-name "*Authors*") diff --git a/lisp/abbrev.el b/lisp/abbrev.el index f370bd3ea6a..b0e8a4fa99c 100644 --- a/lisp/abbrev.el +++ b/lisp/abbrev.el @@ -973,11 +973,11 @@ full text instead of the abbrevs that expand into that text." (buf (get-buffer-create "*abbrev-suggest*"))) (set-buffer buf) (erase-buffer) - (insert "** Abbrev expansion usage ** + (insert (substitute-command-keys "** Abbrev expansion usage ** Below is a list of expansions for which abbrevs are defined, and the number of times the expansion was typed manually. To display -and edit all abbrevs, type `M-x edit-abbrevs RET'\n\n") +and edit all abbrevs, type \\[edit-abbrevs].\n\n")) (dolist (expansion totals) (insert (format " %s: %d\n" (car expansion) (cdr expansion)))) (display-buffer buf))) diff --git a/lisp/calc/calc.el b/lisp/calc/calc.el index 45a4d56a371..b9bdc0fd8dc 100644 --- a/lisp/calc/calc.el +++ b/lisp/calc/calc.el @@ -731,7 +731,7 @@ If nil, symbolic math routines make no assumptions about variables.") "Initial height of Calculator window.") (defcalcmodevar calc-display-trail t - "If non-nil, M-x calc creates a window to display Calculator trail.") + "If non-nil, \\[calc] creates a window to display Calculator trail.") (defcalcmodevar calc-show-selections t "If non-nil, selected sub-formulas are shown by obscuring rest of formula. @@ -1468,7 +1468,9 @@ See `window-dedicated-p' for what that means." (with-current-buffer (calc-trail-buffer) (and calc-display-trail (calc-trail-display 1 t))) - (message "Welcome to the GNU Emacs Calculator! Press `?' or `h' for help, `q' to quit") + (message (substitute-command-keys + (concat "Welcome to the GNU Emacs Calculator! \\" + "Press \\[calc-help] or \\[calc-help-prefix] for help, \\[calc-quit] to quit"))) (run-hooks 'calc-start-hook) (and (windowp full-display) (window-point full-display) diff --git a/lisp/completion.el b/lisp/completion.el index e36c7228416..643f2da0d21 100644 --- a/lisp/completion.el +++ b/lisp/completion.el @@ -1088,7 +1088,8 @@ Must be called after `find-exact-completion'." #'completion-locate-db-error "27.1") (defun completion-locate-db-error () ;; recursive error: really scrod - (error "Completion database corrupted. Try M-x clear-all-completions. Send bug report")) + (error (substitute-command-keys + "Completion database corrupted. Try \\[clear-all-completions]. Send bug report"))) ;; WRITES (defun add-completion-to-tail-if-new (string) diff --git a/lisp/dired-x.el b/lisp/dired-x.el index cf257c8169d..7c6f49f2ae4 100644 --- a/lisp/dired-x.el +++ b/lisp/dired-x.el @@ -293,7 +293,7 @@ files"] \\[dired-omit-mode]\t-- toggle omitting of files \\[dired-mark-sexp]\t-- mark by Lisp expression -To see the options you can set, use M-x customize-group RET dired-x RET. +To see the options you can set, use \\[customize-group] RET dired-x RET. See also the functions: `dired-flag-extension' `dired-virtual' diff --git a/lisp/emacs-lisp/package.el b/lisp/emacs-lisp/package.el index a204966644e..a0bfcbb24fa 100644 --- a/lisp/emacs-lisp/package.el +++ b/lisp/emacs-lisp/package.el @@ -2268,7 +2268,9 @@ confirmation to install packages." (mapconcat #'symbol-name available " ")))) (mapc (lambda (p) (package-install p 'dont-select)) available))) ((> difference 0) - (message "Packages that are not available: %d (the rest is already installed), maybe you need to `M-x package-refresh-contents'" + (message (substitute-command-keys + "Packages that are not available: %d (the rest is already \ +installed), maybe you need to \\[package-refresh-contents]") difference)) (t (message "All your packages are already installed")))))) diff --git a/lisp/emulation/viper.el b/lisp/emulation/viper.el index 6ba265f8abf..e9c0fb5e24b 100644 --- a/lisp/emulation/viper.el +++ b/lisp/emulation/viper.el @@ -577,7 +577,7 @@ For more information on Viper: To submit a bug report or to contact the author, type :submitReport in Vi command mode. To shoo Viper away and return to pure Emacs (horror!), type: - M-x viper-go-away + \\[viper-go-away] This startup message appears whenever you load Viper, unless you type `y' now." )) diff --git a/lisp/facemenu.el b/lisp/facemenu.el index 7229d6163df..7417bb12030 100644 --- a/lisp/facemenu.el +++ b/lisp/facemenu.el @@ -541,10 +541,11 @@ If the optional argument LIST is non-nil, it should be a list of colors to display. Otherwise, this command computes a list of colors that the current display can handle. Customize `list-colors-sort' to change the order in which colors are shown. -Type `g' or \\[revert-buffer] after customizing `list-colors-sort' -to redisplay colors in the new order. +Type \\\\[revert-buffer] after customizing \ +`list-colors-sort' to redisplay colors in +the new order. -If the optional argument BUFFER-NAME is nil, it defaults to *Colors*. +If the optional argument BUFFER-NAME is nil, it defaults to \"*Colors*\". If the optional argument CALLBACK is non-nil, it should be a function to call each time the user types RET or clicks on a diff --git a/lisp/mail/emacsbug.el b/lisp/mail/emacsbug.el index 3da1e8b25e9..7c3f6ba5e6d 100644 --- a/lisp/mail/emacsbug.el +++ b/lisp/mail/emacsbug.el @@ -426,7 +426,7 @@ usually do not have translators for other languages.\n\n"))) (with-output-to-temp-buffer "*Bug Help*" (princ (substitute-command-keys (format "\ -You invoked the command M-x report-emacs-bug, +You invoked the command \\[report-emacs-bug], but you decided not to mail the bug report to the Emacs maintainers. If you want to mail it to someone else instead, diff --git a/lisp/mail/sendmail.el b/lisp/mail/sendmail.el index 312805f6d8f..d0aff093dfe 100644 --- a/lisp/mail/sendmail.el +++ b/lisp/mail/sendmail.el @@ -1950,7 +1950,8 @@ The seventh argument ACTIONS is a list of actions to take (setq initialized t))) (if (and buffer-auto-save-file-name (file-exists-p buffer-auto-save-file-name)) - (message "Auto save file for draft message exists; consider M-x mail-recover")) + (message (substitute-command-keys + "Auto save file for draft message exists; consider \\[mail-recover]"))) initialized)) (declare-function dired-view-file "dired" ()) diff --git a/lisp/menu-bar.el b/lisp/menu-bar.el index ede81867825..b2577c085fc 100644 --- a/lisp/menu-bar.el +++ b/lisp/menu-bar.el @@ -2490,7 +2490,9 @@ created in the future." ;; after this function returns, overwriting any message we do here. (when (and (called-interactively-p 'interactive) (not menu-bar-mode)) (run-with-idle-timer 0 nil 'message - "Menu Bar mode disabled. Use M-x menu-bar-mode to make the menu bar appear."))) + (substitute-command-keys + "Menu Bar mode disabled. \ +Use \\[menu-bar-mode] to make the menu bar appear.")))) ;;;###autoload ;; (This does not work right unless it comes after the above definition.) diff --git a/lisp/org/org.el b/lisp/org/org.el index d03676e3fb9..4a74eda8427 100644 --- a/lisp/org/org.el +++ b/lisp/org/org.el @@ -15215,9 +15215,9 @@ This function is useful in a setup where one tracks Org files with a version control system, to revert on one machine after pulling changes from another. I believe the procedure must be like this: -1. M-x org-save-all-org-buffers +1. \\[org-save-all-org-buffers] 2. Pull changes from the other machine, resolve conflicts -3. M-x org-revert-all-org-buffers" +3. \\[org-revert-all-org-buffers]" (interactive) (unless (yes-or-no-p "Revert all Org buffers from their files? ") (user-error "Abort")) diff --git a/lisp/progmodes/antlr-mode.el b/lisp/progmodes/antlr-mode.el index a74ca1ed239..0b7945430d3 100644 --- a/lisp/progmodes/antlr-mode.el +++ b/lisp/progmodes/antlr-mode.el @@ -570,7 +570,7 @@ See \\[antlr-show-makefile-rules] and `antlr-unknown-file-formats'.") "The following Makefile rules define the dependencies for all (non- expanded) grammars in directory \"%s\".\n They are stored in the kill-ring, i.e., you can insert them with C-y -into your Makefile. You can also invoke M-x antlr-show-makefile-rules +into your Makefile. You can also invoke \\[antlr-show-makefile-rules] from within a Makefile to insert them directly.\n\n\n" "Introduction to use with \\[antlr-show-makefile-rules]. It is a format string and used with substitution DIRECTORY/%s where @@ -2167,7 +2167,8 @@ command `antlr-show-makefile-rules' for detail." (unless in-makefile (copy-region-as-kill (point-min) (point-max)) (goto-char (point-min)) - (insert (format antlr-help-rules-intro dirname))))) + (insert (format (substitute-command-keys antlr-help-rules-intro) + dirname))))) ;;;###autoload (defun antlr-show-makefile-rules () diff --git a/lisp/progmodes/gdb-mi.el b/lisp/progmodes/gdb-mi.el index 3e5b8e2f32b..fa54f511608 100644 --- a/lisp/progmodes/gdb-mi.el +++ b/lisp/progmodes/gdb-mi.el @@ -766,7 +766,9 @@ NOARG must be t when this macro is used outside `gud-def'." ;; Apparently we're not running with -i=mi (or we're, for ;; instance, debugging something inside a Docker instance with ;; Emacs on the outside). - (let ((msg "Error: Either -i=mi wasn't specified on the GDB command line, or the extra socket couldn't be established. Consider using `M-x gud-gdb' instead.")) + (let ((msg (substitute-command-keys + "Error: Either -i=mi wasn't specified on the GDB command line,\ + or the extra socket couldn't be established. Consider using \\[gud-gdb] instead."))) (message msg) (setq string (concat (propertize msg 'font-lock-face 'error) "\n" string))) diff --git a/lisp/progmodes/xscheme.el b/lisp/progmodes/xscheme.el index 70763319840..1874f2698ae 100644 --- a/lisp/progmodes/xscheme.el +++ b/lisp/progmodes/xscheme.el @@ -908,8 +908,8 @@ the remaining input.") xscheme-signal-death-message) (progn (beep) - (message -"The Scheme process has died! Do M-x reset-scheme to restart it")))))) + (message (substitute-command-keys +"The Scheme process has died! Type \\[reset-scheme] to restart it"))))))) (defun xscheme-process-filter-initialize (running-p) (setq xscheme-process-filter-state 'idle) diff --git a/lisp/ps-print.el b/lisp/ps-print.el index 38671b58e2b..1f4ed4e44d7 100644 --- a/lisp/ps-print.el +++ b/lisp/ps-print.el @@ -2788,7 +2788,7 @@ Each element comprises: font family (the key), name, bold, italic, bold-italic, reference size, line height, space width, average character width. To get the info for another specific font (say Helvetica), do the following: - create a new buffer -- generate the PostScript image to a file (C-u M-x ps-print-buffer) +- generate the PostScript image to a file (\\[universal-argument] \\[ps-print-buffer]) - open this file and delete the leading `%' (which is the PostScript comment character) from the line `% 3 cm 20 cm moveto 10/Courier ReportFontInfo showpage' diff --git a/lisp/recentf.el b/lisp/recentf.el index 9ae059a70dd..57cbaf0debb 100644 --- a/lisp/recentf.el +++ b/lisp/recentf.el @@ -1122,8 +1122,9 @@ IGNORE arguments." (setq-local recentf-edit-list nil) (widget-insert (format-message - "Click on OK to delete selected files from the recent list. -Click on Cancel or type `q' to cancel.\n")) + (substitute-command-keys + "Click on OK to delete selected files from the recent list. +Click on Cancel or type \\[recentf-cancel-dialog] to cancel.\n"))) ;; Insert the list of files as checkboxes (dolist (item recentf-list) (widget-create 'checkbox @@ -1221,7 +1222,8 @@ use for the dialog. It defaults to \"*`recentf-menu-title'*\"." ", or type the corresponding digit key," "") " to open it.\n" - (format-message "Click on Cancel or type `q' to cancel.\n")) + (substitute-command-keys + "Click on Cancel or type \\[recentf-cancel-dialog] to cancel.\n")) ;; Use a L&F that looks like the recentf menu. (tree-widget-set-theme "folder") (apply #'widget-create diff --git a/lisp/vc/ediff-util.el b/lisp/vc/ediff-util.el index 5646fd3d42a..9016d1df5c4 100644 --- a/lisp/vc/ediff-util.el +++ b/lisp/vc/ediff-util.el @@ -2777,8 +2777,8 @@ up an appropriate window config." (interactive) (ediff-barf-if-not-control-buffer) (run-hooks 'ediff-suspend-hook) - (message - "To resume, type M-x eregistry and select the desired Ediff session")) + (message (substitute-command-keys + "To resume, type \\[eregistry] and select the desired Ediff session"))) ;; ediff-barf-if-not-control-buffer ensures only called from ediff. (declare-function ediff-version "ediff" ()) diff --git a/lisp/vc/pcvs.el b/lisp/vc/pcvs.el index 726fe4e2837..bbc81ef195d 100644 --- a/lisp/vc/pcvs.el +++ b/lisp/vc/pcvs.el @@ -1144,7 +1144,8 @@ Full documentation is in the Texinfo file." ("->" cvs-secondary-branch-prefix)))) " " cvs-mode-line-process)) (if buffer-file-name - (error "Use M-x cvs-quickdir to get a *cvs* buffer")) + (error (substitute-command-keys + "Use \\[cvs-quickdir] to get a *cvs* buffer"))) (buffer-disable-undo) ;;(setq-local goal-column cvs-cursor-column) (setq-local revert-buffer-function 'cvs-mode-revert-buffer) diff --git a/lisp/vc/vc-bzr.el b/lisp/vc/vc-bzr.el index bfe3293e45a..48fedeca5a8 100644 --- a/lisp/vc/vc-bzr.el +++ b/lisp/vc/vc-bzr.el @@ -1054,7 +1054,8 @@ stream. Standard error output is discarded." (vc-bzr-command "info" t 0 dir) (buffer-string))) (shelve (vc-bzr-shelve-list)) - (shelve-help-echo "Use M-x vc-bzr-shelve to create shelves") + (shelve-help-echo (substitute-command-keys + "Use \\[vc-bzr-shelve] to create shelves")) (root-dir (vc-bzr-root dir)) (pending-merge ;; FIXME: looking for .bzr/checkout/merge-hashes is not a -- cgit v1.2.3 From 3b3211c0239b0d3cb6587f3ef6968f51f2d30fd2 Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Wed, 13 Oct 2021 21:52:50 +0200 Subject: Mark def* macros for indentation * lisp/widget.el (define-widget-keywords): * lisp/vc/pcvs.el (defun-cvs-mode): * lisp/subr.el (defvar-local): (defvar-keymap): * lisp/skeleton.el (define-skeleton): * lisp/simple.el (define-alternatives): * lisp/progmodes/gud.el (gdb-script-mode): * lisp/progmodes/gdb-mi.el (def-gdb-preempt-display-buffer): (def-gdb-auto-update-trigger): (def-gdb-auto-update-handler): (def-gdb-trigger-and-handler): (def-gdb-thread-buffer-command): (def-gdb-thread-buffer-simple-command): (def-gdb-thread-buffer-gud-command): (def-gdb-set-positive-number): (def-gdb-memory-format): (def-gdb-memory-unit): (def-gdb-memory-show-page): * lisp/progmodes/compile.el (define-compilation-mode): * lisp/progmodes/cc-vars.el (defcustom-c-stylevar): * lisp/obsolete/cl.el (define-setf-expander): (defsetf): (define-modify-macro): * lisp/obsolete/cl-compat.el (defkeyword): * lisp/net/hmac-def.el (define-hmac-function): * lisp/international/mule-conf.el (define-iso-single-byte-charset): * lisp/international/ccl.el (define-ccl-program): * lisp/image.el (defimage): * lisp/gnus/gmm-utils.el (defun-gmm): * lisp/ezimage.el (defezimage): * lisp/erc/erc.el (define-erc-module): * lisp/emacs-lisp/shortdoc.el (define-short-documentation-group): * lisp/emacs-lisp/eieio.el (defclass): * lisp/emacs-lisp/eieio-compat.el (defgeneric): (defmethod): * lisp/emacs-lisp/easy-mmode.el (define-minor-mode): (define-globalized-minor-mode): * lisp/emacs-lisp/derived.el (define-derived-mode): * lisp/emacs-lisp/byte-run.el (defsubst): (define-obsolete-function-alias): (define-obsolete-variable-alias): * lisp/custom.el (defcustom): (defface): (defgroup): (deftheme): * lisp/cedet/semantic/wisent.el (define-wisent-lexer): * lisp/cedet/semantic/lex.el (define-lex): (define-lex-analyzer): (define-lex-regex-analyzer): (define-lex-simple-regex-analyzer): (define-lex-block-analyzer): (define-lex-keyword-type-analyzer): (define-lex-sexp-type-analyzer): (define-lex-regex-type-analyzer): (define-lex-string-type-analyzer): (define-lex-block-type-analyzer): * lisp/cedet/semantic/lex-spp.el (define-lex-spp-macro-declaration-analyzer): (define-lex-spp-macro-undeclaration-analyzer): (define-lex-spp-include-analyzer): * lisp/cedet/semantic/dep.el (defcustom-mode-local-semantic-dependency-system-include-path): * lisp/cedet/semantic/decorate/mode.el (define-semantic-decoration-style): * lisp/cedet/mode-local.el (define-child-mode): (define-overloadable-function): (define-mode-local-override): * lisp/calc/calc.el (defcalcmodevar): (defmath): Explicitly mark all macros that have names that start with "def" that should indent defunly-like (bug#43329). --- lisp/calc/calc.el | 4 ++-- lisp/cedet/mode-local.el | 4 +++- lisp/cedet/semantic/decorate/mode.el | 1 + lisp/cedet/semantic/dep.el | 1 + lisp/cedet/semantic/lex-spp.el | 9 ++++++--- lisp/cedet/semantic/lex.el | 17 ++++++++++++----- lisp/cedet/semantic/wisent.el | 2 +- lisp/custom.el | 8 +++++--- lisp/emacs-lisp/byte-run.el | 6 +++--- lisp/emacs-lisp/derived.el | 7 +------ lisp/emacs-lisp/easy-mmode.el | 3 ++- lisp/emacs-lisp/eieio-compat.el | 4 +++- lisp/emacs-lisp/eieio.el | 2 +- lisp/emacs-lisp/shortdoc.el | 1 + lisp/erc/erc.el | 2 +- lisp/ezimage.el | 1 + lisp/gnus/gmm-utils.el | 1 + lisp/image.el | 2 +- lisp/international/ccl.el | 2 +- lisp/international/mule-conf.el | 1 + lisp/net/hmac-def.el | 1 + lisp/obsolete/cl-compat.el | 1 + lisp/obsolete/cl.el | 9 ++++++--- lisp/progmodes/cc-vars.el | 2 +- lisp/progmodes/compile.el | 1 + lisp/progmodes/gdb-mi.el | 11 +++++++++++ lisp/progmodes/gud.el | 4 ++-- lisp/simple.el | 1 + lisp/skeleton.el | 3 ++- lisp/subr.el | 3 ++- lisp/vc/pcvs.el | 1 + lisp/widget.el | 2 +- 32 files changed, 78 insertions(+), 39 deletions(-) (limited to 'lisp/progmodes/gdb-mi.el') diff --git a/lisp/calc/calc.el b/lisp/calc/calc.el index 553bdc9c6ed..bd4ec4ff2f0 100644 --- a/lisp/calc/calc.el +++ b/lisp/calc/calc.el @@ -494,7 +494,7 @@ This setting only applies to floats in normal display mode.") (defmacro defcalcmodevar (var defval &optional doc) "Declare VAR as a Calc variable, with default value DEFVAL and doc-string DOC. The variable VAR will be added to `calc-mode-var-list'." - (declare (doc-string 3)) + (declare (doc-string 3) (indent defun)) `(progn (defvar ,var ,defval ,doc) (add-to-list 'calc-mode-var-list (list (quote ,var) ,defval)))) @@ -3439,7 +3439,7 @@ The prefix `calcFunc-' is added to the specified name to get the actual Lisp function name. See Info node `(calc)Defining Functions'." - (declare (doc-string 3)) ;; FIXME: Edebug spec? + (declare (doc-string 3) (indent defun)) ;; FIXME: Edebug spec? (require 'calc-ext) (math-do-defmath func args body)) diff --git a/lisp/cedet/mode-local.el b/lisp/cedet/mode-local.el index 18fb05e7eb4..e0717fbfe5a 100644 --- a/lisp/cedet/mode-local.el +++ b/lisp/cedet/mode-local.el @@ -156,7 +156,7 @@ local variables have been defined." DOCSTRING is optional and not used. To work properly, this should be put after PARENT mode local variables definition." - (declare (obsolete define-derived-mode "27.1")) + (declare (obsolete define-derived-mode "27.1") (indent 2)) `(mode-local--set-parent ',mode ',parent)) (defun mode-local-use-bindings-p (this-mode desired-mode) @@ -567,6 +567,7 @@ appropriate arguments deduced from ARGS. OVERARGS is a list of arguments passed to the override and `NAME-default' function, in place of those deduced from ARGS." (declare (doc-string 3) + (indent defun) (debug (&define name lambda-list stringp def-body))) `(eval-and-compile (defun ,name ,args @@ -595,6 +596,7 @@ DOCSTRING is the documentation string. BODY is the implementation of this function." ;; FIXME: Make this obsolete and use cl-defmethod with &context instead. (declare (doc-string 4) + (indent defun) (debug (&define name symbolp lambda-list stringp def-body))) (let ((newname (intern (format "%s-%s" name mode)))) `(progn diff --git a/lisp/cedet/semantic/decorate/mode.el b/lisp/cedet/semantic/decorate/mode.el index 6271fb1ced6..0a234b3000d 100644 --- a/lisp/cedet/semantic/decorate/mode.el +++ b/lisp/cedet/semantic/decorate/mode.el @@ -391,6 +391,7 @@ etc., found in the semantic-decorate library. To add other kind of decorations on a tag, `NAME-highlight' must use `semantic-decorate-tag', and other functions of the semantic decoration API found in this library." + (declare (indent 1)) (let ((predicate (semantic-decorate-style-predicate name)) (highlighter (semantic-decorate-style-highlighter name)) (predicatedef (semantic-decorate-style-predicate-default name)) diff --git a/lisp/cedet/semantic/dep.el b/lisp/cedet/semantic/dep.el index 0694b9c2329..cae38e6f111 100644 --- a/lisp/cedet/semantic/dep.el +++ b/lisp/cedet/semantic/dep.el @@ -82,6 +82,7 @@ users will customize. Creates a customizable variable users can customize that will keep semantic data structures up to date." + (declare (indent defun)) `(progn ;; Create a variable users can customize. (defcustom ,name ,value diff --git a/lisp/cedet/semantic/lex-spp.el b/lisp/cedet/semantic/lex-spp.el index 8073640a8bd..3297367db90 100644 --- a/lisp/cedet/semantic/lex-spp.el +++ b/lisp/cedet/semantic/lex-spp.el @@ -1165,7 +1165,8 @@ of type `spp-macro-def' is to be created. VALFORM are forms that return the value to be saved for this macro, or nil. When implementing a macro, you can use `semantic-lex-spp-stream-for-macro' to convert text into a lexical stream for storage in the macro." - (declare (debug (&define name stringp stringp form def-body))) + (declare (debug (&define name stringp stringp form def-body)) + (indent 1)) (let ((start (make-symbol "start")) (end (make-symbol "end")) (val (make-symbol "val")) @@ -1199,7 +1200,8 @@ REGEXP is a regular expression for the analyzer to match. See `define-lex-regex-analyzer' for more on regexp. TOKIDX is an index into REGEXP for which a new lexical token of type `spp-macro-undef' is to be created." - (declare (debug (&define name stringp stringp form))) + (declare (debug (&define name stringp stringp form)) + (indent 1)) (let ((start (make-symbol "start")) (end (make-symbol "end"))) `(define-lex-regex-analyzer ,name @@ -1260,7 +1262,8 @@ type of include. The return value should be of the form: (NAME . TYPE) where NAME is the name of the include, and TYPE is the type of the include, where a valid symbol is `system', or nil." - (declare (debug (&define name stringp stringp form def-body))) + (declare (debug (&define name stringp stringp form def-body)) + (indent 1)) (let ((start (make-symbol "start")) (end (make-symbol "end")) (val (make-symbol "val")) diff --git a/lisp/cedet/semantic/lex.el b/lisp/cedet/semantic/lex.el index 69f20deeb76..d524b733db5 100644 --- a/lisp/cedet/semantic/lex.el +++ b/lisp/cedet/semantic/lex.el @@ -760,7 +760,7 @@ If two analyzers can match the same text, it is important to order the analyzers so that the one you want to match first occurs first. For example, it is good to put a number analyzer in front of a symbol analyzer which might mistake a number for a symbol." - (declare (debug (&define name stringp (&rest symbolp)))) + (declare (debug (&define name stringp (&rest symbolp))) (indent 1)) `(defun ,name (start end &optional depth length) ,(concat doc "\nSee `semantic-lex' for more information.") ;; Make sure the state of block parsing starts over. @@ -1096,7 +1096,7 @@ Proper action in FORMS is to move the value of `semantic-lex-end-point' to after the location of the analyzed entry, and to add any discovered tokens at the beginning of `semantic-lex-token-stream'. This can be done by using `semantic-lex-push-token'." - (declare (debug (&define name stringp form def-body))) + (declare (debug (&define name stringp form def-body)) (indent 1)) `(eval-and-compile ;; This is the real info used by `define-lex' (via semantic-lex-one-token). (defconst ,name '(,condition ,@forms) ,doc) @@ -1118,7 +1118,7 @@ This can be done by using `semantic-lex-push-token'." "Create a lexical analyzer with NAME and DOC that will match REGEXP. FORMS are evaluated upon a successful match. See `define-lex-analyzer' for more about analyzers." - (declare (debug (&define name stringp form def-body))) + (declare (debug (&define name stringp form def-body)) (indent 1)) `(define-lex-analyzer ,name ,doc (looking-at ,regexp) @@ -1137,7 +1137,8 @@ FORMS are evaluated upon a successful match BEFORE the new token is created. It is valid to ignore FORMS. See `define-lex-analyzer' for more about analyzers." (declare (debug - (&define name stringp form symbolp [ &optional form ] def-body))) + (&define name stringp form symbolp [ &optional form ] def-body)) + (indent 1)) `(define-lex-analyzer ,name ,doc (looking-at ,regexp) @@ -1162,7 +1163,8 @@ where BLOCK-SYM is the symbol returned in a block token. OPEN-DELIM and CLOSE-DELIM are respectively the open and close delimiters identifying a block. OPEN-SYM and CLOSE-SYM are respectively the symbols returned in open and close tokens." - (declare (debug (&define name stringp form (&rest form)))) + (declare (debug (&define name stringp form (&rest form))) + (indent 1)) (let ((specs (cons spec1 specs)) spec open olist clist) (while specs @@ -1471,6 +1473,7 @@ syntax as specified by the syntax table." (defmacro define-lex-keyword-type-analyzer (name doc syntax) "Define a keyword type analyzer NAME with DOC string. SYNTAX is the regexp that matches a keyword syntactic expression." + (declare (indent 1)) (let ((key (make-symbol "key"))) `(define-lex-analyzer ,name ,doc @@ -1486,6 +1489,7 @@ SYNTAX is the regexp that matches a keyword syntactic expression." "Define a sexp type analyzer NAME with DOC string. SYNTAX is the regexp that matches the beginning of the s-expression. TOKEN is the lexical token returned when SYNTAX matches." + (declare (indent 1)) `(define-lex-regex-analyzer ,name ,doc ,syntax @@ -1504,6 +1508,7 @@ SYNTAX is the regexp that matches a syntactic expression. MATCHES is an alist of lexical elements used to refine the syntactic expression. DEFAULT is the default lexical token returned when no MATCHES." + (declare (indent 1)) (if matches (let* ((val (make-symbol "val")) (lst (make-symbol "lst")) @@ -1536,6 +1541,7 @@ SYNTAX is the regexp that matches a syntactic expression. MATCHES is an alist of lexical elements used to refine the syntactic expression. DEFAULT is the default lexical token returned when no MATCHES." + (declare (indent 1)) (if matches (let* ((val (make-symbol "val")) (lst (make-symbol "lst")) @@ -1633,6 +1639,7 @@ When the lexer encounters the open-paren delimiter \"(\": - If the maximum depth of parenthesis tracking is reached (current depth >= max depth), it returns the whole parenthesis block as a (PAREN_BLOCK start . end) token." + (declare (indent 1)) (let* ((val (make-symbol "val")) (lst (make-symbol "lst")) (elt (make-symbol "elt"))) diff --git a/lisp/cedet/semantic/wisent.el b/lisp/cedet/semantic/wisent.el index f5f381d4079..afcdd142822 100644 --- a/lisp/cedet/semantic/wisent.el +++ b/lisp/cedet/semantic/wisent.el @@ -66,7 +66,7 @@ Returned tokens must have the form: (TOKSYM VALUE START . END) where VALUE is the buffer substring between START and END positions." - (declare (debug (&define name stringp def-body))) + (declare (debug (&define name stringp def-body)) (indent 1)) `(defun ,name () ,doc (cond diff --git a/lisp/custom.el b/lisp/custom.el index 0cd4318e63d..a04af9abaa5 100644 --- a/lisp/custom.el +++ b/lisp/custom.el @@ -364,7 +364,8 @@ call that function directly. See Info node `(elisp) Customization' in the Emacs Lisp manual for more information." - (declare (doc-string 3) (debug (name body))) + (declare (doc-string 3) (debug (name body)) + (indent defun)) ;; It is better not to use backquote in this file, ;; because that makes a bootstrapping problem ;; if you need to recompile all the Lisp files using interpreted code. @@ -447,7 +448,7 @@ In the ATTS property list, possible attributes are `:family', See Info node `(elisp) Faces' in the Emacs Lisp manual for more information." - (declare (doc-string 3)) + (declare (doc-string 3) (indent defun)) ;; It is better not to use backquote in this file, ;; because that makes a bootstrapping problem ;; if you need to recompile all the Lisp files using interpreted code. @@ -511,7 +512,7 @@ For a list of valid keywords, see the common keywords listed in See Info node `(elisp) Customization' in the Emacs Lisp manual for more information." - (declare (doc-string 3)) + (declare (doc-string 3) (indent defun)) ;; It is better not to use backquote in this file, ;; because that makes a bootstrapping problem ;; if you need to recompile all the Lisp files using interpreted code. @@ -1142,6 +1143,7 @@ The optional argument DOC is a doc string describing the theme. Any theme `foo' should be defined in a file called `foo-theme.el'; see `custom-make-theme-feature' for more information." (declare (doc-string 2) + (indent 1) (advertised-calling-convention (theme &optional doc) "22.1")) (let ((feature (custom-make-theme-feature theme))) ;; It is better not to use backquote in this file, diff --git a/lisp/emacs-lisp/byte-run.el b/lisp/emacs-lisp/byte-run.el index da86fa5cecf..d82d9454e84 100644 --- a/lisp/emacs-lisp/byte-run.el +++ b/lisp/emacs-lisp/byte-run.el @@ -380,7 +380,7 @@ You don't need this. (See bytecomp.el commentary for more details.) "Define an inline function. The syntax is just like that of `defun'. \(fn NAME ARGLIST &optional DOCSTRING DECL &rest BODY)" - (declare (debug defun) (doc-string 3)) + (declare (debug defun) (doc-string 3) (indent 2)) (or (memq (get name 'byte-optimizer) '(nil byte-compile-inline-expand)) (error "`%s' is a primitive" name)) @@ -434,7 +434,7 @@ WHEN should be a string indicating when the function was first made obsolete, for example a date or a release number. See the docstrings of `defalias' and `make-obsolete' for more details." - (declare (doc-string 4)) + (declare (doc-string 4) (indent defun)) `(progn (defalias ,obsolete-name ,current-name ,docstring) (make-obsolete ,obsolete-name ,current-name ,when))) @@ -483,7 +483,7 @@ For the benefit of Customize, if OBSOLETE-NAME has any of the following properties, they are copied to CURRENT-NAME, if it does not already have them: `saved-value', `saved-variable-comment'." - (declare (doc-string 4)) + (declare (doc-string 4) (indent defun)) `(progn (defvaralias ,obsolete-name ,current-name ,docstring) ;; See Bug#4706. diff --git a/lisp/emacs-lisp/derived.el b/lisp/emacs-lisp/derived.el index dd30846546b..af5eecc22a5 100644 --- a/lisp/emacs-lisp/derived.el +++ b/lisp/emacs-lisp/derived.el @@ -175,12 +175,7 @@ See Info node `(elisp)Derived Modes' for more details. (declare (debug (&define name symbolp sexp [&optional stringp] [&rest keywordp sexp] def-body)) (doc-string 4) - ;; Ask not what - ;;(indent 3) - ;; can do for you, ask what it can do to others. IOW, the - ;; missing of indentation setting here is the indentation - ;; setting and not an oversight. - ) + (indent defun)) (when (and docstring (not (stringp docstring))) ;; Some trickiness, since what appears to be the docstring may really be diff --git a/lisp/emacs-lisp/easy-mmode.el b/lisp/emacs-lisp/easy-mmode.el index f752861d80a..db86e0e0292 100644 --- a/lisp/emacs-lisp/easy-mmode.el +++ b/lisp/emacs-lisp/easy-mmode.el @@ -198,6 +198,7 @@ INIT-VALUE LIGHTER KEYMAP. \(fn MODE DOC [KEYWORD VAL ... &rest BODY])" (declare (doc-string 2) + (indent defun) (debug (&define name string-or-null-p [&optional [¬ keywordp] sexp &optional [¬ keywordp] sexp @@ -450,7 +451,7 @@ after running the major mode's hook. However, MODE is not turned on if the hook has explicitly disabled it. \(fn GLOBAL-MODE MODE TURN-ON [KEY VALUE]... BODY...)" - (declare (doc-string 2)) + (declare (doc-string 2) (indent defun)) (let* ((global-mode-name (symbol-name global-mode)) (mode-name (symbol-name mode)) (pretty-name (easy-mmode-pretty-mode-name mode)) diff --git a/lisp/emacs-lisp/eieio-compat.el b/lisp/emacs-lisp/eieio-compat.el index 6d84839c341..60b0638c63f 100644 --- a/lisp/emacs-lisp/eieio-compat.el +++ b/lisp/emacs-lisp/eieio-compat.el @@ -70,7 +70,8 @@ is appropriate to use. Uses `defmethod' to create methods, and calls `defgeneric' for you. With this implementation the ARGS are currently ignored. You can use `defgeneric' to apply specialized top level documentation to a method." - (declare (doc-string 3) (obsolete cl-defgeneric "25.1")) + (declare (doc-string 3) (obsolete cl-defgeneric "25.1") + (indent defun)) `(eieio--defalias ',method (eieio--defgeneric-init-form ',method @@ -103,6 +104,7 @@ Summary: \"doc-string\" body)" (declare (doc-string 3) (obsolete cl-defmethod "25.1") + (indent defun) (debug (&define ; this means we are defining something [&name sexp] ;Allow (setf ...) additionally to symbols. diff --git a/lisp/emacs-lisp/eieio.el b/lisp/emacs-lisp/eieio.el index 2dc3e0aeffa..3d73e5fef7b 100644 --- a/lisp/emacs-lisp/eieio.el +++ b/lisp/emacs-lisp/eieio.el @@ -110,7 +110,7 @@ Options in CLOS not supported in EIEIO: Due to the way class options are set up, you can add any tags you wish, and reference them using the function `class-option'." - (declare (doc-string 4)) + (declare (doc-string 4) (indent defun)) (cl-check-type superclasses list) (cond ((and (stringp (car options-and-doc)) diff --git a/lisp/emacs-lisp/shortdoc.el b/lisp/emacs-lisp/shortdoc.el index 17ac3e471c0..8f654372079 100644 --- a/lisp/emacs-lisp/shortdoc.el +++ b/lisp/emacs-lisp/shortdoc.el @@ -71,6 +71,7 @@ string, it'll be inserted as is, then the string will be `read', and then evaluated. There can be any number of :example/:result elements." + (declare (indent defun)) `(progn (setq shortdoc--groups (delq (assq ',group shortdoc--groups) shortdoc--groups)) diff --git a/lisp/erc/erc.el b/lisp/erc/erc.el index 885d311cf38..2a28dafab28 100644 --- a/lisp/erc/erc.el +++ b/lisp/erc/erc.el @@ -1291,7 +1291,7 @@ Example: #\\='erc-replace-insert)) ((remove-hook \\='erc-insert-modify-hook #\\='erc-replace-insert)))" - (declare (doc-string 3)) + (declare (doc-string 3) (indent defun)) (let* ((sn (symbol-name name)) (mode (intern (format "erc-%s-mode" (downcase sn)))) (group (intern (format "erc-%s" (downcase sn)))) diff --git a/lisp/ezimage.el b/lisp/ezimage.el index 13f5c039a7f..57033cde058 100644 --- a/lisp/ezimage.el +++ b/lisp/ezimage.el @@ -45,6 +45,7 @@ (defmacro defezimage (variable imagespec docstring) "Define VARIABLE as an image if `defimage' is not available. IMAGESPEC is the image data, and DOCSTRING is documentation for the image." + (declare (indent defun)) `(progn (defimage ,variable ,imagespec ,docstring) (put (quote ,variable) 'ezimage t))) diff --git a/lisp/gnus/gmm-utils.el b/lisp/gnus/gmm-utils.el index bcf8dd014bc..68a90989046 100644 --- a/lisp/gnus/gmm-utils.el +++ b/lisp/gnus/gmm-utils.el @@ -239,6 +239,7 @@ DEFAULT-MAP specifies the default key map for ICON-LIST." "Create function NAME. If FUNCTION exists, then NAME becomes an alias for FUNCTION. Otherwise, create function NAME with ARG-LIST and BODY." + (declare (indent defun)) (let ((defined-p (fboundp function))) (if defined-p `(defalias ',name ',function) diff --git a/lisp/image.el b/lisp/image.el index 6e1dbbdf5cd..2022b41d1f0 100644 --- a/lisp/image.el +++ b/lisp/image.el @@ -791,7 +791,7 @@ Example: (defimage test-image ((:type xpm :file \"~/test1.xpm\") (:type xbm :file \"~/test1.xbm\")))" - (declare (doc-string 3)) + (declare (doc-string 3) (indent defun)) `(defvar ,symbol (find-image ',specs) ,doc)) diff --git a/lisp/international/ccl.el b/lisp/international/ccl.el index 629cd4c2879..883b0b60fc9 100644 --- a/lisp/international/ccl.el +++ b/lisp/international/ccl.el @@ -1553,7 +1553,7 @@ MAP := MAP-IDs := MAP-ID ... MAP-SET := MAP-IDs | (MAP-IDs) MAP-SET MAP-ID := integer" - (declare (doc-string 3)) + (declare (doc-string 3) (indent defun)) `(let ((prog ,(unwind-protect (progn ;; To make ,(charset-id CHARSET) works well. diff --git a/lisp/international/mule-conf.el b/lisp/international/mule-conf.el index 9a68fce2e81..ec027e9a932 100644 --- a/lisp/international/mule-conf.el +++ b/lisp/international/mule-conf.el @@ -148,6 +148,7 @@ (defmacro define-iso-single-byte-charset (symbol iso-symbol name nickname iso-ir iso-final emacs-mule-id map) + (declare (indent defun)) `(progn (define-charset ,symbol ,name diff --git a/lisp/net/hmac-def.el b/lisp/net/hmac-def.el index 5af6d4324ae..5778857ff80 100644 --- a/lisp/net/hmac-def.el +++ b/lisp/net/hmac-def.el @@ -37,6 +37,7 @@ a string and return a digest of it (in binary form). B is a byte length of a block size of H. (B=64 for both SHA1 and MD5.) L is a byte length of hash outputs. (L=16 for MD5, L=20 for SHA1.) If BIT is non-nil, truncate output to specified bits." + (declare (indent defun)) `(defun ,name (text key) ,(concat "Compute " (upcase (symbol-name name)) diff --git a/lisp/obsolete/cl-compat.el b/lisp/obsolete/cl-compat.el index 619bc06122b..0dba366192e 100644 --- a/lisp/obsolete/cl-compat.el +++ b/lisp/obsolete/cl-compat.el @@ -52,6 +52,7 @@ ;;; Keyword routines not supported by new package. (defmacro defkeyword (x &optional doc) + (declare (indent defun)) (cl-list* 'defconst x (list 'quote x) (and doc (list doc)))) (defun keyword-of (sym) diff --git a/lisp/obsolete/cl.el b/lisp/obsolete/cl.el index 9df62318572..a892ed7c76b 100644 --- a/lisp/obsolete/cl.el +++ b/lisp/obsolete/cl.el @@ -513,7 +513,8 @@ a temporary-variables list, a value-forms list, a store-variables list See `gv-define-expander', and `gv-define-setter' for better and simpler ways to define setf-methods." (declare (debug - (&define name cl-lambda-list cl-declarations-or-string def-body))) + (&define name cl-lambda-list cl-declarations-or-string def-body)) + (indent defun)) `(progn ,@(if (stringp (car body)) (list `(put ',name 'setf-documentation ,(pop body)))) @@ -554,7 +555,8 @@ You can replace this form with `gv-define-setter'. (&define name [&or [symbolp &optional stringp] [cl-lambda-list (symbolp)]] - cl-declarations-or-string def-body))) + cl-declarations-or-string def-body)) + (indent defun)) (if (and (listp arg1) (consp args)) ;; Like `gv-define-setter' but with `cl-function'. `(gv-define-expander ,name @@ -615,7 +617,8 @@ arguments from ARGLIST using FUNC. For example: You can replace this macro with `gv-letplace'." (declare (debug (&define name cl-lambda-list ;; should exclude &key - symbolp &optional stringp))) + symbolp &optional stringp)) + (indent defun)) (if (memq '&key arglist) (error "&key not allowed in define-modify-macro")) (require 'cl-macs) ;For cl--arglist-args. diff --git a/lisp/progmodes/cc-vars.el b/lisp/progmodes/cc-vars.el index d843c783ed0..83fd3da7c1d 100644 --- a/lisp/progmodes/cc-vars.el +++ b/lisp/progmodes/cc-vars.el @@ -179,7 +179,7 @@ STYLE stands for the choice where the value is taken from some style setting. PREAMBLE is optionally prepended to FOO; that is, if FOO contains :tag or :value, the respective two-element list component is ignored." - (declare (debug (symbolp form stringp &rest))) + (declare (debug (symbolp form stringp &rest)) (indent defun)) (let* ((expanded-doc (concat doc " This is a style variable. Apart from the valid values described diff --git a/lisp/progmodes/compile.el b/lisp/progmodes/compile.el index 73f98068110..2b480e89507 100644 --- a/lisp/progmodes/compile.el +++ b/lisp/progmodes/compile.el @@ -2227,6 +2227,7 @@ The parent is always `compilation-mode' and the customizable `compilation-...' variables are also set from the name of the mode you have chosen, by replacing the first word, e.g., `compilation-scroll-output' from `grep-scroll-output' if that variable exists." + (declare (indent defun)) (let ((mode-name (replace-regexp-in-string "-mode\\'" "" (symbol-name mode)))) `(define-derived-mode ,mode compilation-mode ,name ,doc diff --git a/lisp/progmodes/gdb-mi.el b/lisp/progmodes/gdb-mi.el index fa54f511608..39fcfd341cb 100644 --- a/lisp/progmodes/gdb-mi.el +++ b/lisp/progmodes/gdb-mi.el @@ -1612,6 +1612,7 @@ this trigger is subscribed to `gdb-buf-publisher' and called with ;; Used to display windows with thread-bound buffers (defmacro def-gdb-preempt-display-buffer (name buffer &optional doc split-horizontal) + (declare (indent defun)) `(defun ,name (&optional thread) ,(when doc doc) (message "%s" thread) @@ -3012,6 +3013,7 @@ calling `gdb-current-context-command'). Triggers defined by this command are meant to be used as a trigger argument when describing buffer types with `gdb-set-buffer-rules'." + (declare (indent defun)) `(defun ,trigger-name (&optional signal) (when (or (not ,signal-list) @@ -3032,6 +3034,7 @@ Erase current buffer and evaluate CUSTOM-DEFUN. Then call `gdb-update-buffer-name'. If NOPRESERVE is non-nil, window point is not restored after CUSTOM-DEFUN." + (declare (indent defun)) `(defun ,handler-name () (let* ((inhibit-read-only t) ,@(unless nopreserve @@ -3055,6 +3058,7 @@ See `def-gdb-auto-update-trigger'. HANDLER-NAME handler uses customization of CUSTOM-DEFUN. See `def-gdb-auto-update-handler'." + (declare (indent defun)) `(progn (def-gdb-auto-update-trigger ,trigger-name ,gdb-command @@ -3473,6 +3477,7 @@ corresponding to the mode line clicked." CUSTOM-DEFUN may use locally bound `thread' variable, which will be the value of `gdb-thread' property of the current line. If `gdb-thread' is nil, error is signaled." + (declare (indent defun)) `(defun ,name (&optional event) ,(when doc doc) (interactive (list last-input-event)) @@ -3488,6 +3493,7 @@ If `gdb-thread' is nil, error is signaled." &optional doc) "Define a NAME which will call BUFFER-COMMAND with id of thread on the current line." + (declare (indent defun)) `(def-gdb-thread-buffer-command ,name (,buffer-command (gdb-mi--field thread 'id)) ,doc)) @@ -3543,6 +3549,7 @@ on the current line." "Define a NAME which will execute GUD-COMMAND with `gdb-thread-number' locally bound to id of thread on the current line." + (declare (indent defun)) `(def-gdb-thread-buffer-command ,name (if gdb-non-stop (let ((gdb-thread-number (gdb-mi--field thread 'id)) @@ -3711,6 +3718,7 @@ in `gdb-memory-format'." (defmacro def-gdb-set-positive-number (name variable echo-string &optional doc) "Define a function NAME which reads new VAR value from minibuffer." + (declare (indent defun)) `(defun ,name (event) ,(when doc doc) (interactive "e") @@ -3739,6 +3747,7 @@ in `gdb-memory-format'." "Define a function NAME to switch memory buffer to use FORMAT. DOC is an optional documentation string." + (declare (indent defun)) `(defun ,name () ,(when doc doc) (interactive) (customize-set-variable 'gdb-memory-format ,format) @@ -3808,6 +3817,7 @@ DOC is an optional documentation string." "Define a function NAME to switch memory unit size to UNIT-SIZE. DOC is an optional documentation string." + (declare (indent defun)) `(defun ,name () ,(when doc doc) (interactive) (customize-set-variable 'gdb-memory-unit ,unit-size) @@ -3832,6 +3842,7 @@ The defined function switches Memory buffer to show address stored in ADDRESS-VAR variable. DOC is an optional documentation string." + (declare (indent defun)) `(defun ,name ,(when doc doc) (interactive) diff --git a/lisp/progmodes/gud.el b/lisp/progmodes/gud.el index 2061d414802..9b884c4ff80 100644 --- a/lisp/progmodes/gud.el +++ b/lisp/progmodes/gud.el @@ -3539,8 +3539,8 @@ Treats actions as defuns." #'gdb-script-end-of-defun) (setq-local font-lock-defaults '(gdb-script-font-lock-keywords nil nil ((?_ . "w")) nil - (font-lock-syntactic-face-function - . gdb-script-font-lock-syntactic-face))) + (font-lock-syntactic-face-function + . gdb-script-font-lock-syntactic-face))) ;; Recognize docstrings. (setq-local syntax-propertize-function gdb-script-syntax-propertize-function) diff --git a/lisp/simple.el b/lisp/simple.el index 841983a3b60..7b6c52a3898 100644 --- a/lisp/simple.el +++ b/lisp/simple.el @@ -9859,6 +9859,7 @@ does not have any effect until this variable is set. CUSTOMIZATIONS, if non-nil, should be composed of alternating `defcustom' keywords and values to add to the declaration of `COMMAND-alternatives' (typically :group and :version)." + (declare (indent defun)) (let* ((command-name (symbol-name command)) (varalt-name (concat command-name "-alternatives")) (varalt-sym (intern varalt-name)) diff --git a/lisp/skeleton.el b/lisp/skeleton.el index c363fb2c489..2b183996d83 100644 --- a/lisp/skeleton.el +++ b/lisp/skeleton.el @@ -113,7 +113,8 @@ are integer buffer positions in the reverse order of the insertion order.") "Define a user-configurable COMMAND that enters a statement skeleton. DOCUMENTATION is that of the command. SKELETON is as defined under `skeleton-insert'." - (declare (doc-string 2) (debug (&define name stringp skeleton-edebug-spec))) + (declare (doc-string 2) (debug (&define name stringp skeleton-edebug-spec)) + (indent defun)) (if skeleton-debug (set command skeleton)) `(progn diff --git a/lisp/subr.el b/lisp/subr.el index 46cd4c127dc..a1858e5911b 100644 --- a/lisp/subr.el +++ b/lisp/subr.el @@ -193,7 +193,7 @@ set earlier in the `setq-local'. The return value of the "Define VAR as a buffer-local variable with default value VAL. Like `defvar' but additionally marks the variable as being automatically buffer-local wherever it is set." - (declare (debug defvar) (doc-string 3)) + (declare (debug defvar) (doc-string 3) (indent 2)) ;; Can't use backquote here, it's too early in the bootstrap. (list 'progn (list 'defvar var val docstring) (list 'make-variable-buffer-local (list 'quote var)))) @@ -6551,6 +6551,7 @@ macro also accepts a `:doc' keyword, which (if present) is used as the variable documentation string. \(fn VARIABLE-NAME &key DOC FULL PARENT SUPPRESS NAME PREFIX KEYMAP &rest [KEY DEFINITION]...)" + (declare (indent 1)) (let ((opts nil) doc) (while (and defs diff --git a/lisp/vc/pcvs.el b/lisp/vc/pcvs.el index 8f662e84589..0413b2bc56b 100644 --- a/lisp/vc/pcvs.el +++ b/lisp/vc/pcvs.el @@ -758,6 +758,7 @@ clear what alternative to use. - `DOUBLE' is the generic case." (declare (debug (&define sexp lambda-list stringp ("interactive" interactive) def-body)) + (indent defun) (doc-string 3)) (let ((style (cvs-cdr fun)) (fun (cvs-car fun))) diff --git a/lisp/widget.el b/lisp/widget.el index 0d1977164b3..0232f6cf93f 100644 --- a/lisp/widget.el +++ b/lisp/widget.el @@ -44,7 +44,7 @@ ;; (list 'or (list 'boundp (list 'car 'keywords)) ;; (list 'set (list 'car 'keywords) (list 'car 'keywords))) ;; (list 'setq 'keywords (list 'cdr 'keywords))))) - (declare (obsolete nil "27.1")) + (declare (obsolete nil "27.1") (indent defun)) nil) ;;(define-widget-keywords :documentation-indent -- cgit v1.2.3