commit fc10e7fe5ff924ab0047c62a0fd9d72df38b21b6 (HEAD, refs/remotes/origin/master) Author: Stefan Kangas Date: Fri Sep 17 09:45:21 2021 +0200 * lisp/allout.el (allout-old-expose-topic): Make obsolete. diff --git a/lisp/allout.el b/lisp/allout.el index 09977aae84..bb36524658 100644 --- a/lisp/allout.el +++ b/lisp/allout.el @@ -5056,7 +5056,6 @@ 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. @@ -5088,7 +5087,7 @@ elements of the list are nested SPECs, dictating the specific exposure for the corresponding offspring of the topic. Optional FOLLOWERS arguments dictate exposure for succeeding siblings." - + (declare (obsolete allout-expose-topic "28.1")) (interactive "xExposure spec: ") (let ((inhibit-field-text-motion t) (depth (allout-current-depth)) commit b95157de2dcd402185927baf61ce114f554a66e2 Author: John Cummings Date: Thu Sep 16 23:00:50 2021 +0000 Fix disk-free info in 'insert-directory' * lisp/files.el (insert-directory): Call 'get-free-disk-space' with the argument FILE, to make sure the reported info is for the correct volume. (Bug#50630) Copyright-paperwork-exempt: yes diff --git a/lisp/files.el b/lisp/files.el index 3a397f812e..b113ff32f2 100644 --- a/lisp/files.el +++ b/lisp/files.el @@ -7615,7 +7615,7 @@ normally equivalent short `-D' option is just passed on to ;; Replace "total" with "total used in directory" to ;; avoid confusion. (replace-match "total used in directory" nil nil nil 1) - (let ((available (get-free-disk-space "."))) + (let ((available (get-free-disk-space file))) (when available (end-of-line) (insert " available " available)))))))))) commit a462ccd5364fef1d9b439dad81908a09be5eb1ba Author: Michael Albinus Date: Fri Sep 17 07:29:01 2021 +0200 Fix annoyance in tramp-smb.el * lisp/net/tramp-smb.el (tramp-smb-maybe-open-connection): Add "TERM=dumb". diff --git a/lisp/net/tramp-smb.el b/lisp/net/tramp-smb.el index fa5bce74bb..5c2d7d008a 100644 --- a/lisp/net/tramp-smb.el +++ b/lisp/net/tramp-smb.el @@ -2049,7 +2049,10 @@ If ARGUMENT is non-nil, use it as argument for (let* ((coding-system-for-read nil) (process-connection-type tramp-process-connection-type) (p (let ((default-directory - (tramp-compat-temporary-file-directory))) + (tramp-compat-temporary-file-directory)) + (process-environment + (cons (concat "TERM=" tramp-terminal-type) + process-environment))) (apply #'start-process (tramp-get-connection-name vec) (tramp-get-connection-buffer vec) commit c6eb114a42922af18818dce7317238e0af776958 Author: Olivier Certner Date: Fri Feb 5 15:34:50 2021 +0100 ERC: NickServ: Prompt for password last, overall simplifications (bug#46777) When 'erc-prompt-for-nickserv-password' is non-nil, don't ignore the other forms of identification. Instead, process them first, and prompt for the password last. Separate concerns (determination of the nick to use, of the password to use, and actual message sending). Note that the user can be interactively prompted for a password on reception of a NickServ request, as before (on 'erc-prompt-for-nickserv-password'). * lisp/erc/erc-services.el (erc-nickserv-identify): Make the password argument optional (and don't prompt for it interactively). Further, now take the nick to use for identification (interactively, ask for it, defaulting to the current one). Move the actual message sending into the new 'erc-nickserv-send-identify' function, and the password prompting into 'erc-nickserv-get-password'. (erc-nickserv-send-identify): New function containing the code for sending the identify message to NickServ, given the nick and password. (erc-nickserv-get-password): Try each password source in turn, in the following order: 'erc-nickserv-passwords', auth-source (if 'erc-use-auth-source-for-nickserv-password' is non-nil), and in the end prompt the user interactively (if 'erc-prompt-for-nickserv-password' is non-nil). If one source returns a string, the function returns it, or nil if the string is empty. (erc-nickserv-call-identify-function): Declare obsolete, but retain for backward compatibility. Prefer invoking 'erc-nickserv-identify' directly instead. (erc-nickserv-identify-autodetect, erc-nickserv-identify-on-connect) (erc-nickserv-identify-on-nick-change): Call 'erc-nickserv-identify' directly ('erc-nickserv-call-identify-function' has been obsoleted). For the last two functions, remove the redundant checks on the NickServ identification flags (additionally, it is doubtful they have any measurable impact on performance). * etc/NEWS: Announce the change. Co-authored-by: F. Jason Park diff --git a/etc/NEWS b/etc/NEWS index 17c42ce104..eee6d2592b 100644 --- a/etc/NEWS +++ b/etc/NEWS @@ -2632,13 +2632,22 @@ Interactively, 'C-u C-c C-o' triggers this new optional behavior. ** ERC --- -*** erc-services.el now supports NickServ passwords from auth-source. +*** NickServ passwords can now be retrieved from auth-source. The 'erc-use-auth-source-for-nickserv-password' user option enables querying auth-source for NickServ passwords. To enable this, add the following to your init file: - (setq erc-prompt-for-nickserv-password nil - erc-use-auth-source-for-nickserv-password t) + (setq erc-use-auth-source-for-nickserv-password t) + +--- +*** NickServ identification now prompts for password last. +When 'erc-prompt-for-nickserv-password' is non-nil, the user used to +be unconditionally prompted interactively for a password, regardless +of the value of 'erc-nickserv-passwords', which was effectively +ignored (same for the new +'erc-use-auth-source-for-nickserv-password'). This limitation is now +lifted, and the user is interactively prompted last, after the other +identification methods have run. --- *** The '/ignore' command will now ask for a timeout to stop ignoring the user. diff --git a/lisp/erc/erc-services.el b/lisp/erc/erc-services.el index 61006e0c02..adb3f521cd 100644 --- a/lisp/erc/erc-services.el +++ b/lisp/erc/erc-services.el @@ -169,9 +169,8 @@ You can also use \\[erc-nickserv-identify-mode] to change modes." (defcustom erc-use-auth-source-for-nickserv-password nil "Query auth-source for a password when identifiying to NickServ. -This option has an no effect if `erc-prompt-for-nickserv-password' -is non-nil, and passwords from `erc-nickserv-passwords' take -precedence." +Passwords from `erc-nickserv-passwords' take precedence. See +function `erc-nickserv-get-password'." :version "28.1" :type 'boolean) @@ -405,85 +404,114 @@ password for this nickname, otherwise try to send it automatically." identify-regex (string-match identify-regex msg)) (erc-log "NickServ IDENTIFY request detected") - (erc-nickserv-call-identify-function nick) + (erc-nickserv-identify nil nick) nil)))) (defun erc-nickserv-identify-on-connect (_server nick) "Identify to Nickserv after the connection to the server is established." - (unless (or (and (null erc-nickserv-passwords) - (null erc-prompt-for-nickserv-password) - (null erc-use-auth-source-for-nickserv-password)) - (and (eq erc-nickserv-identify-mode 'both) - (erc-nickserv-alist-regexp (erc-network)))) - (erc-nickserv-call-identify-function nick))) + (unless (and (eq erc-nickserv-identify-mode 'both) + (erc-nickserv-alist-regexp (erc-network))) + (erc-nickserv-identify nil nick))) (defun erc-nickserv-identify-on-nick-change (nick _old-nick) "Identify to Nickserv whenever your nick changes." - (unless (or (and (null erc-nickserv-passwords) - (null erc-prompt-for-nickserv-password) - (null erc-use-auth-source-for-nickserv-password)) - (and (eq erc-nickserv-identify-mode 'both) - (erc-nickserv-alist-regexp (erc-network)))) - (erc-nickserv-call-identify-function nick))) - -(defun erc-nickserv-get-password (nickname) - "Return the password for NICKNAME from configured sources. - -It uses `erc-nickserv-passwords' and additionally auth-source -when `erc-use-auth-source-for-nickserv-password' is not nil." - (or - (when erc-nickserv-passwords - (cdr (assoc nickname - (nth 1 (assoc (erc-network) - erc-nickserv-passwords))))) - (when erc-use-auth-source-for-nickserv-password - (let* ((secret (nth 0 (auth-source-search - :max 1 :require '(:secret) - :host (erc-with-server-buffer erc-session-server) - :port (format ; ensure we have a string - "%s" (erc-with-server-buffer erc-session-port)) - :user nickname)))) - (when secret - (let ((passwd (plist-get secret :secret))) - (if (functionp passwd) (funcall passwd) passwd))))))) - -(defun erc-nickserv-call-identify-function (nickname) - "Call `erc-nickserv-identify'. -Either call it interactively or run it with NICKNAME's password, -depending on the value of `erc-prompt-for-nickserv-password'." - (if erc-prompt-for-nickserv-password - (call-interactively 'erc-nickserv-identify) - (erc-nickserv-identify (erc-nickserv-get-password nickname)))) + (unless (and (eq erc-nickserv-identify-mode 'both) + (erc-nickserv-alist-regexp (erc-network))) + (erc-nickserv-identify nil nick))) + +(defun erc-nickserv-get-password (nick) + "Return the password for NICK from configured sources. +First, a password for NICK is looked up in +`erc-nickserv-passwords'. Then, it is looked up in auth-source +if `erc-use-auth-source-for-nickserv-password' is not nil. +Finally, interactively prompt the user, if +`erc-prompt-for-nickserv-password' is true. + +As soon as some source returns a password, the sequence of +lookups stops and this function returns it (or returns nil if it +is empty). Otherwise, no corresponding password was found, and +it returns nil." + (let (network server port) + ;; Fill in local vars, switching to the server buffer once only + (erc-with-server-buffer + (setq network erc-network + server erc-session-server + port erc-session-port)) + (let ((ret + (or + (when erc-nickserv-passwords + (cdr (assoc nick + (cl-second (assoc network + erc-nickserv-passwords))))) + (when erc-use-auth-source-for-nickserv-password + (let ((secret (cl-first (auth-source-search + :max 1 :require '(:secret) + :host server + ;; Ensure a string for :port + :port (format "%s" port) + :user nick)))) + (when secret + (let ((passwd (plist-get secret :secret))) + (if (functionp passwd) (funcall passwd) passwd))))) + (when erc-prompt-for-nickserv-password + (read-passwd + (format "NickServ password for %s on %s (RET to cancel): " + nick network)))))) + (when (and ret (not (string= ret ""))) + ret)))) (defvar erc-auto-discard-away) -;;;###autoload -(defun erc-nickserv-identify (password) +(defun erc-nickserv-send-identify (nick password) "Send an \"identify \" message to NickServ. -When called interactively, read the password using `read-passwd'." +Returns t if the message could be sent, nil otherwise." + (let* ((erc-auto-discard-away nil) + (network (erc-network)) + (nickserv-info (assoc network erc-nickserv-alist)) + (nickserv (or (erc-nickserv-alist-nickserv nil nickserv-info) + "NickServ")) + (identify-word (or (erc-nickserv-alist-ident-keyword + nil nickserv-info) + "IDENTIFY")) + (nick (if (erc-nickserv-alist-use-nick-p nil nickserv-info) + (concat nick " ") + "")) + (msgtype (or (erc-nickserv-alist-ident-command nil nickserv-info) + "PRIVMSG"))) + (erc-message msgtype + (concat nickserv " " identify-word " " nick password)))) + +(defun erc-nickserv-call-identify-function (nickname) + "Call `erc-nickserv-identify' with NICKNAME." + (declare (obsolete erc-nickserv-identify "28.1")) + (erc-nickserv-identify nil nickname)) + +;;;###autoload +(defun erc-nickserv-identify (&optional password nick) + "Identify to NickServ immediately. +Identification will either use NICK or the current nick if not +provided, and some password obtained through +`erc-nickserv-get-password' (which see). If no password can be +found, an error is reported trough `erc-error'. + +Interactively, the user will be prompted for NICK, an empty +string meaning to default to the current nick. + +Returns t if the identify message could be sent, nil otherwise." (interactive - (list (read-passwd - (format "NickServ password for %s on %s (RET to cancel): " - (erc-current-nick) - (or (and (erc-network) - (symbol-name (erc-network))) - "Unknown network"))))) - (when (and password (not (string= "" password))) - (let* ((erc-auto-discard-away nil) - (network (erc-network)) - (nickserv-info (assoc network erc-nickserv-alist)) - (nickserv (or (erc-nickserv-alist-nickserv nil nickserv-info) - "NickServ")) - (identify-word (or (erc-nickserv-alist-ident-keyword - nil nickserv-info) - "IDENTIFY")) - (nick (if (erc-nickserv-alist-use-nick-p nil nickserv-info) - (concat (erc-current-nick) " ") - "")) - (msgtype (or (erc-nickserv-alist-ident-command nil nickserv-info) - "PRIVMSG"))) - (erc-message msgtype - (concat nickserv " " identify-word " " nick password))))) + (list + nil + (read-from-minibuffer "Nickname: " nil nil nil + 'erc-nick-history-list (erc-current-nick)))) + (unless (and nick (not (string= nick ""))) + (setq nick (erc-current-nick))) + (unless password + (setq password (erc-nickserv-get-password nick))) + (if password + (erc-nickserv-send-identify nick password) + (erc-error "Cannot find a password for nickname %s" + nick) + nil)) (provide 'erc-services) commit f7ed946874c345d8e4ea2891d58160f1139548d6 Author: Amin Bandali Date: Thu Sep 16 22:45:46 2021 -0400 * lisp/erc/erc-button.el (erc-emacswiki-url): Update to shorter address. diff --git a/lisp/erc/erc-button.el b/lisp/erc/erc-button.el index 4e9547dfde..040606ea85 100644 --- a/lisp/erc/erc-button.el +++ b/lisp/erc/erc-button.el @@ -194,9 +194,10 @@ PAR is a number of a regexp grouping whose text will be passed to :inline t (integer :tag "Regexp section number"))))) -(defcustom erc-emacswiki-url "https://www.emacswiki.org/cgi-bin/wiki.pl?" +(defcustom erc-emacswiki-url "https://www.emacswiki.org/emacs/" "URL of the EmacsWiki website." - :type 'string) + :type 'string + :version "28.1") (defcustom erc-emacswiki-lisp-url "https://www.emacswiki.org/elisp/" "URL of the EmacsWiki ELisp area." commit 7e27cb6e729d4a3cc3282db3b25f6d104ae17f0a Author: Alfred M. Szmidt Date: Fri Sep 17 02:03:22 2021 +0300 * lisp/vc/vc.el: API doc fixes. diff --git a/lisp/vc/vc.el b/lisp/vc/vc.el index 1d4a2e8113..8767969163 100644 --- a/lisp/vc/vc.el +++ b/lisp/vc/vc.el @@ -431,7 +431,7 @@ ;; and displays a file name and a revision, then return a cons ;; (REVISION . FILENAME). ;; -;; - region-history (FILE BUFFER LFROM LTO) +;; - region-history (file buffer lfrom lto) ;; ;; Insert into BUFFER the history (log comments and diffs) of the content of ;; FILE between lines LFROM and LTO. This is typically done asynchronously. @@ -496,7 +496,7 @@ ;; `.bzrignore'. The default behavior is to read the contents of ;; the file returned by the `find-ignore-file' function. ;; -;; - find-ignore-file +;; - find-ignore-file (file) ;; ;; Return the ignore file that controls FILE, e.g. `.gitignore' or ;; `.bzrignore'. commit 2e5740894a78dba4b19a80b19e54cabfa7cdb767 Author: Manuel Giraud Date: Fri Sep 17 02:01:09 2021 +0300 Reuse vc-read-backend more * lisp/vc/vc.el (vc-read-backend): New optional arguments. (vc-create-repo): Use it here. (vc-switch-backend): And here (bug#50603). diff --git a/lisp/vc/vc.el b/lisp/vc/vc.el index 512f07d2f6..1d4a2e8113 100644 --- a/lisp/vc/vc.el +++ b/lisp/vc/vc.el @@ -1157,10 +1157,12 @@ BEWARE: this function may change the current buffer." (eq p q) (and (member p '(edited added removed)) (member q '(edited added removed))))) -(defun vc-read-backend (prompt) - (intern - (completing-read prompt (mapcar #'symbol-name vc-handled-backends) - nil 'require-match))) +(defun vc-read-backend (prompt &optional backends default) + (let ((backends (or backends vc-handled-backends)) + (completion-ignore-case t)) + (intern + (completing-read prompt (mapcar #'symbol-name backends) + nil 'require-match nil nil default)))) ;; Here's the major entry point. @@ -1369,14 +1371,7 @@ For old-style locking-based version control systems, like RCS: (defun vc-create-repo (backend) "Create an empty repository in the current directory." - (interactive - (list - (intern - (upcase - (completing-read - "Create repository for: " - (mapcar (lambda (b) (list (downcase (symbol-name b)))) vc-handled-backends) - nil t))))) + (interactive (list (vc-read-backend "Create repository for: "))) (vc-call-backend backend 'create-repo)) ;;;###autoload @@ -2884,12 +2879,7 @@ To get a prompt, use a prefix argument." (cond ((null others) (error "No other backend to switch to")) (current-prefix-arg - (intern - (upcase - (completing-read - (format "Switch to backend [%s]: " def) - (mapcar (lambda (b) (list (downcase (symbol-name b)))) backends) - nil t nil nil (downcase (symbol-name def)))))) + (vc-read-backend "Switch to backend: " backends (symbol-name def))) (t def)))))) (unless (eq backend (vc-backend file)) (vc-file-clearprops file) commit 3f9f3ba4370bd4d0f33392befb35328327d73b1e Author: Stefan Kangas Date: Thu Sep 16 20:05:48 2021 +0200 Docfix: use command substitution for 'universal-argument' * lisp/autoarg.el (autoarg-mode): * lisp/bookmark.el (bookmark-set, bookmark-set-no-overwrite) (bookmark-save): * lisp/calendar/todo-mode.el (todo-insert-item) (todo-filter-top-priorities) (todo-filter-top-priorities-multifile): * lisp/dired-x.el (dired-mark-extension, dired-mark-suffix): * lisp/eshell/eshell.el (eshell): * lisp/gnus/gnus-group.el (gnus-group-find-new-groups): * lisp/gnus/gnus-start.el (gnus-find-new-newsgroups): * lisp/gnus/gnus-sum.el (gnus-summary-show-article): * lisp/gnus/gnus.el (gnus-secondary-servers): * lisp/org/org-timer.el (org-timer-set-timer): * lisp/org/ox.el (org-export-dispatch-last-position): * lisp/printing.el (pr-ps-directory-preview) (pr-ps-directory-using-ghostscript, pr-ps-directory-print) (pr-ps-directory-ps-print, pr-ps-buffer-preview) (pr-ps-buffer-using-ghostscript, pr-ps-buffer-print) (pr-ps-buffer-ps-print, pr-despool-preview) (pr-despool-using-ghostscript, pr-despool-print) (pr-despool-ps-print, pr-ps-file-up-ps-print, pr-ps-fast-fire) (pr-txt-fast-fire): * lisp/progmodes/idlwave.el (idlwave-complete): * lisp/progmodes/sh-script.el (sh-set-shell): * lisp/replace.el (occur): * lisp/ses.el (ses--advice-yank): * lisp/simple.el (set-mark-command-repeat-pop): * lisp/sort.el (delete-duplicate-lines): * lisp/strokes.el (strokes-help): * lisp/textmodes/artist.el (artist-mode): * lisp/textmodes/reftex-cite.el (reftex-citation): * lisp/textmodes/reftex-dcr.el (reftex-view-crossref): * lisp/textmodes/reftex-index.el (reftex-index-selection-or-word) (reftex-display-index): * lisp/textmodes/reftex-ref.el (reftex-reference): * lisp/textmodes/reftex-toc.el (reftex-toc): * lisp/textmodes/reftex-vars.el (reftex-cite-prompt-optional-args) (reftex-enable-partial-scans): * lisp/textmodes/texnfo-upd.el (texinfo-master-menu): * lisp/windmove.el (windmove-display-in-direction) (windmove-delete-left, windmove-delete-up) (windmove-delete-right, windmove-delete-down): * lisp/window.el (recenter-window-group, recenter-other-window): Use command substitution for 'universal-argument' instead of raw "C-u". diff --git a/lisp/autoarg.el b/lisp/autoarg.el index 7c2c6f1030..b52a4305be 100644 --- a/lisp/autoarg.el +++ b/lisp/autoarg.el @@ -104,7 +104,7 @@ For example: `6 9 a' inserts 69 `a's into the buffer. `6 9 \\[autoarg-terminate] \\[autoarg-terminate]' inserts `69' into the buffer and then invokes the normal binding of \\[autoarg-terminate]. -`C-u \\[autoarg-terminate]' invokes the normal binding of \\[autoarg-terminate] four times. +`\\[universal-argument] \\[autoarg-terminate]' invokes the normal binding of \\[autoarg-terminate] four times. \\{autoarg-mode-map}" :lighter" Aarg" :global t :group 'keyboard) diff --git a/lisp/bookmark.el b/lisp/bookmark.el index 56aec1c4f9..ac63c8f1b0 100644 --- a/lisp/bookmark.el +++ b/lisp/bookmark.el @@ -908,11 +908,11 @@ 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 yank successive words. -Typing C-u inserts (at the bookmark name prompt) the name of the last +Typing \\[universal-argument] inserts (at the bookmark name prompt) the name of the last bookmark used in the document where the new bookmark is being set; this helps you use a single bookmark name to track progress through a large document. If there is no prior bookmark for this document, then -C-u inserts an appropriate name based on the buffer or file. +\\[universal-argument] inserts an appropriate name based on the buffer or file. Use \\[bookmark-delete] to remove bookmarks (you give it a name and it removes only the first instance of a bookmark with that name from @@ -941,11 +941,11 @@ 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 yank successive words. -Typing C-u inserts (at the bookmark name prompt) the name of the last +Typing \\[universal-argument] inserts (at the bookmark name prompt) the name of the last bookmark used in the document where the new bookmark is being set; this helps you use a single bookmark name to track progress through a large document. If there is no prior bookmark for this document, then -C-u inserts an appropriate name based on the buffer or file. +\\[universal-argument] inserts an appropriate name based on the buffer or file. Use \\[bookmark-delete] to remove bookmarks (you give it a name and it removes only the first instance of a bookmark with that name from @@ -1494,7 +1494,7 @@ is greater than `bookmark-alist-modification-count'." "Save currently defined bookmarks in FILE. FILE defaults to `bookmark-default-file'. With prefix PARG, query user for a file to save in. -If MAKE-DEFAULT is non-nil (interactively with prefix C-u C-u) +If MAKE-DEFAULT is non-nil (interactively with prefix \\[universal-argument] \\[universal-argument]) the file we save in becomes the new default in the current Emacs session (without affecting the value of `bookmark-default-file'.). diff --git a/lisp/calendar/todo-mode.el b/lisp/calendar/todo-mode.el index 68e29d4cec..51a2751132 100644 --- a/lisp/calendar/todo-mode.el +++ b/lisp/calendar/todo-mode.el @@ -1846,9 +1846,9 @@ consist of the last todo items and the first done items." This inserts a new todo item into a category. With no prefix argument ARG, add the item to the current -category; with one prefix argument (`C-u'), prompt for a category -from the current todo file; with two prefix arguments (`C-u -C-u'), first prompt for a todo file, then a category in that +category; with one prefix argument (\\[universal-argument]), prompt for a category +from the current todo file; with two prefix arguments (\\[universal-argument] +\\[universal-argument]), first prompt for a todo file, then a category in that file. If a non-existing category is entered, ask whether to add it to the todo file; if answered affirmatively, add the category and insert the item there. @@ -3969,14 +3969,14 @@ See `todo-set-top-priorities' for more details." The categories can be any of those in the current todo file. With numerical prefix ARG show at most ARG top priority items -from each category. With `C-u' as prefix argument show the +from each category. With \\[universal-argument] as prefix argument show the numbers of top priority items specified by category in `todo-top-priorities-overrides', if this has an entry for the file(s); otherwise show `todo-top-priorities' items per category in the file(s). With no prefix argument, if a top priorities file for the current todo file has previously been saved (see `todo-save-filtered-items-buffer'), visit this file; if there is -no such file, build the list as with prefix argument `C-u'. +no such file, build the list as with prefix argument \\[universal-argument]. The prefix ARG regulates how many top priorities from each category to show, as described above." @@ -3990,14 +3990,14 @@ in `todo-filter-files', or if this nil, in the files chosen from a file selection dialog that pops up in this case. With numerical prefix ARG show at most ARG top priority items -from each category in each file. With `C-u' as prefix argument +from each category in each file. With \\[universal-argument] as prefix argument show the numbers of top priority items specified in `todo-top-priorities-overrides', if this is non-nil; otherwise show `todo-top-priorities' items per category. With no prefix argument, if a top priorities file for the chosen todo files exists (see `todo-save-filtered-items-buffer'), visit this file; if there is no such file, do the same as with prefix argument -`C-u'." +\\[universal-argument]." (interactive "P") (todo-filter-items 'top arg t)) diff --git a/lisp/dired-x.el b/lisp/dired-x.el index 380e47786f..9f9f170173 100644 --- a/lisp/dired-x.el +++ b/lisp/dired-x.el @@ -340,8 +340,8 @@ A `.' is automatically prepended to EXTENSION when not present. EXTENSION may also be a list of extensions instead of a single one. Optional MARKER-CHAR is marker to use. Interactively, ask for EXTENSION. -Prefixed with one C-u, unmark files instead. -Prefixed with two C-u's, prompt for MARKER-CHAR and mark files with it." +Prefixed with one \\[universal-argument], unmark files instead. +Prefixed with two \\[universal-argument]'s, prompt for MARKER-CHAR and mark files with it." (interactive (dired--mark-suffix-interactive-spec)) (unless (listp extension) (setq extension (list extension))) @@ -365,8 +365,8 @@ prepends `.' when not present. SUFFIX may also be a list of suffixes instead of a single one. Optional MARKER-CHAR is marker to use. Interactively, ask for SUFFIX. -Prefixed with one C-u, unmark files instead. -Prefixed with two C-u's, prompt for MARKER-CHAR and mark files with it." +Prefixed with one \\[universal-argument], unmark files instead. +Prefixed with two \\[universal-argument]'s, prompt for MARKER-CHAR and mark files with it." (interactive (dired--mark-suffix-interactive-spec)) (unless (listp suffix) (setq suffix (list suffix))) diff --git a/lisp/eshell/eshell.el b/lisp/eshell/eshell.el index 35153675fa..c66ad00072 100644 --- a/lisp/eshell/eshell.el +++ b/lisp/eshell/eshell.el @@ -240,7 +240,7 @@ session. Return the buffer selected (or created). With a nonnumeric prefix arg, create a new session. -With a numeric prefix arg (as in `C-u 42 M-x eshell RET'), switch +With a numeric prefix arg (as in `\\[universal-argument] 42 \\[eshell]'), switch to the session with that number, or create it if it doesn't already exist. diff --git a/lisp/gnus/gnus-group.el b/lisp/gnus/gnus-group.el index c1b46d6e9e..bedae0f564 100644 --- a/lisp/gnus/gnus-group.el +++ b/lisp/gnus/gnus-group.el @@ -4421,9 +4421,9 @@ group." (defun gnus-group-find-new-groups (&optional arg) "Search for new groups and add them. Each new group will be treated with `gnus-subscribe-newsgroup-method'. -With 1 C-u, use the `ask-server' method to query the server for new +With 1 \\[universal-argument], use the `ask-server' method to query the server for new groups. -With 2 C-u's, use most complete method possible to query the server +With 2 \\[universal-argument]'s, use most complete method possible to query the server for new groups, and subscribe the new groups as zombies." (interactive "p" gnus-group-mode) (let ((new-groups (gnus-find-new-newsgroups (or arg 1))) diff --git a/lisp/gnus/gnus-start.el b/lisp/gnus/gnus-start.el index 1c2e9ebd91..e32cfc0d61 100644 --- a/lisp/gnus/gnus-start.el +++ b/lisp/gnus/gnus-start.el @@ -1068,9 +1068,9 @@ If no function returns `non-nil', call `gnus-subscribe-zombies'." Each new newsgroup will be treated with `gnus-subscribe-newsgroup-method'. The `-n' option line from .newsrc is respected. -With 1 C-u, use the `ask-server' method to query the server for new +With 1 \\[universal-argument], use the `ask-server' method to query the server for new groups. -With 2 C-u's, use most complete method possible to query the server +With 2 \\[universal-argument]'s, use most complete method possible to query the server for new groups, and subscribe the new groups as zombies." (interactive "p" gnus-group-mode) (let* ((gnus-subscribe-newsgroup-method diff --git a/lisp/gnus/gnus-sum.el b/lisp/gnus/gnus-sum.el index f17bb11e6a..2ddd3d2a7e 100644 --- a/lisp/gnus/gnus-sum.el +++ b/lisp/gnus/gnus-sum.el @@ -9839,11 +9839,11 @@ article currently." "Force redisplaying of the current article. If ARG (the prefix) is a number, show the article with the charset defined in `gnus-summary-show-article-charset-alist', or the charset -input. +input.\\ If ARG (the prefix) is non-nil and not a number, show the article, but without running any of the article treatment functions -article. Normally, the keystroke is `C-u g'. When using `C-u -C-u g', show the raw article." +article. Normally, the keystroke is `\\[universal-argument] \\[gnus-summary-show-article]'. When using `\\[universal-argument] +\\[universal-argument] \\[gnus-summary-show-article]', show the raw article." (interactive "P" gnus-summary-mode) (cond ((numberp arg) diff --git a/lisp/gnus/gnus.el b/lisp/gnus/gnus.el index 0505e33cb6..7c983344de 100644 --- a/lisp/gnus/gnus.el +++ b/lisp/gnus/gnus.el @@ -1114,7 +1114,7 @@ that case, just return a fully prefixed name of the group -- (defcustom gnus-secondary-servers nil "List of NNTP servers that the user can choose between interactively. To make Gnus query you for a server, you have to give `gnus' a -non-numeric prefix - `C-u M-x gnus', in short." +non-numeric prefix - `\\[universal-argument] \\[gnus]', in short." :group 'gnus-server :type '(repeat string)) (make-obsolete-variable 'gnus-secondary-servers 'gnus-select-method "24.1") diff --git a/lisp/ldefs-boot.el b/lisp/ldefs-boot.el index 586e4233c5..9cd5c9bfa8 100644 --- a/lisp/ldefs-boot.el +++ b/lisp/ldefs-boot.el @@ -1592,7 +1592,7 @@ For example: `6 9 a' inserts 69 `a's into the buffer. `6 9 \\[autoarg-terminate] \\[autoarg-terminate]' inserts `69' into the buffer and then invokes the normal binding of \\[autoarg-terminate]. -`C-u \\[autoarg-terminate]' invokes the normal binding of \\[autoarg-terminate] four times. +`\\[universal-argument] \\[autoarg-terminate]' invokes the normal binding of \\[autoarg-terminate] four times. \\{autoarg-mode-map} diff --git a/lisp/org/org-timer.el b/lisp/org/org-timer.el index 852d18579a..e2116be701 100644 --- a/lisp/org/org-timer.el +++ b/lisp/org/org-timer.el @@ -400,16 +400,16 @@ prompt the user if she wants to replace it. Called with a numeric prefix argument, use this numeric value as the duration of the timer in minutes. -Called with a `C-u' prefix arguments, use `org-timer-default-timer' +Called with a \\[universal-argument] prefix arguments, use `org-timer-default-timer' without prompting the user for a duration. -With two `C-u' prefix arguments, use `org-timer-default-timer' +With two \\[universal-argument] prefix arguments, use `org-timer-default-timer' without prompting the user for a duration and automatically replace any running timer. By default, the timer duration will be set to the number of minutes in the Effort property, if any. You can ignore this by -using three `C-u' prefix arguments." +using three \\[universal-argument] prefix arguments." (interactive "P") (when (and org-timer-start-time (not org-timer-countdown-timer)) diff --git a/lisp/org/ox.el b/lisp/org/ox.el index 36ecf01483..d412f57360 100644 --- a/lisp/org/ox.el +++ b/lisp/org/ox.el @@ -294,7 +294,7 @@ and its CDR is a list of export options.") (defvar org-export-dispatch-last-position (make-marker) "The position where the last export command was created using the dispatcher. -This marker will be used with `C-u C-c C-e' to make sure export repetition +This marker will be used with `\\[universal-argument] C-c C-e' to make sure export repetition uses the same subtree if the previous command was restricted to a subtree.") ;; For compatibility with Org < 8 diff --git a/lisp/printing.el b/lisp/printing.el index 32ff51a511..89e49ccb2a 100644 --- a/lisp/printing.el +++ b/lisp/printing.el @@ -3476,7 +3476,7 @@ For more information, type \\[pr-interface-help]." "Preview directory using ghostview. Interactively, the command prompts for N-UP printing number, a directory, a -file name regexp for matching and, when you use a prefix argument (C-u), the +file name regexp for matching and, when you use a prefix argument (\\[universal-argument]), the command prompts the user for a file name, and saves the PostScript image in that file instead of saving it in a temporary file. @@ -3505,7 +3505,7 @@ See also documentation for `pr-list-directory'." "Print directory using PostScript through ghostscript. Interactively, the command prompts for N-UP printing number, a directory, a -file name regexp for matching and, when you use a prefix argument (C-u), the +file name regexp for matching and, when you use a prefix argument (\\[universal-argument]), the command prompts the user for a file name, and saves the PostScript image in that file instead of saving it in a temporary file. @@ -3535,7 +3535,7 @@ See also documentation for `pr-list-directory'." "Print directory using PostScript printer. Interactively, the command prompts for N-UP printing number, a directory, a -file name regexp for matching and, when you use a prefix argument (C-u), the +file name regexp for matching and, when you use a prefix argument (\\[universal-argument]), the command prompts the user for a file name, and saves the PostScript image in that file instead of saving it in a temporary file. @@ -3567,7 +3567,7 @@ See also documentation for `pr-list-directory'." It depends on `pr-print-using-ghostscript'. Interactively, the command prompts for N-UP printing number, a directory, a -file name regexp for matching and, when you use a prefix argument (C-u), the +file name regexp for matching and, when you use a prefix argument (\\[universal-argument]), the command prompts the user for a file name, and saves the PostScript image in that file instead of saving it in a temporary file. @@ -3598,7 +3598,7 @@ See also documentation for `pr-list-directory'." "Preview buffer using ghostview. Interactively, the command prompts for N-UP printing number and, when you use a -prefix argument (C-u), the command prompts the user for a file name, and saves +prefix argument (\\[universal-argument]), the command prompts the user for a file name, and saves the PostScript image in that file instead of saving it in a temporary file. Noninteractively, if N-UP is nil, prompts for N-UP printing number. The @@ -3617,7 +3617,7 @@ with that name. If FILENAME is t, prompts for a file name." "Print buffer using PostScript through ghostscript. Interactively, the command prompts for N-UP printing number and, when you use a -prefix argument (C-u), the command prompts the user for a file name, and saves +prefix argument (\\[universal-argument]), the command prompts the user for a file name, and saves the PostScript image in that file instead of sending it to the printer. Noninteractively, if N-UP is nil, prompts for N-UP printing number. The @@ -3636,7 +3636,7 @@ that name. If FILENAME is t, prompts for a file name." "Print buffer using PostScript printer. Interactively, the command prompts for N-UP printing number and, when you use a -prefix argument (C-u), the command prompts the user for a file name, and saves +prefix argument (\\[universal-argument]), the command prompts the user for a file name, and saves the PostScript image in that file instead of sending it to the printer. Noninteractively, if N-UP is nil, prompts for N-UP printing number. The @@ -3657,7 +3657,7 @@ that name. If FILENAME is t, prompts for a file name." It depends on `pr-print-using-ghostscript'. Interactively, the command prompts for N-UP printing number and, when you use a -prefix argument (C-u), the command prompts the user for a file name, and saves +prefix argument (\\[universal-argument]), the command prompts the user for a file name, and saves the PostScript image in that file instead of sending it to the printer. Noninteractively, if N-UP is nil, prompts for N-UP printing number. The @@ -3877,7 +3877,7 @@ See also documentation for `pr-list-directory'." (defun pr-despool-preview (&optional filename) "Preview spooled PostScript. -Interactively, when you use a prefix argument (C-u), the command prompts the +Interactively, when you use a prefix argument (\\[universal-argument]), the command prompts the user for a file name, and saves the spooled PostScript image in that file instead of saving it in a temporary file. @@ -3895,7 +3895,7 @@ PostScript image in a file with that name." (defun pr-despool-using-ghostscript (&optional filename) "Print spooled PostScript using ghostscript. -Interactively, when you use a prefix argument (C-u), the command prompts the +Interactively, when you use a prefix argument (\\[universal-argument]), the command prompts the user for a file name, and saves the spooled PostScript image in that file instead of sending it to the printer. @@ -3914,7 +3914,7 @@ image in a file with that name." (defun pr-despool-print (&optional filename) "Send the spooled PostScript to the printer. -Interactively, when you use a prefix argument (C-u), the command prompts the +Interactively, when you use a prefix argument (\\[universal-argument]), the command prompts the user for a file name, and saves the spooled PostScript image in that file instead of sending it to the printer. @@ -3934,7 +3934,7 @@ image in a file with that name." (defun pr-despool-ps-print (&optional filename) "Send the spooled PostScript to the printer or use ghostscript to print it. -Interactively, when you use a prefix argument (C-u), the command prompts the +Interactively, when you use a prefix argument (\\[universal-argument]), the command prompts the user for a file name, and saves the spooled PostScript image in that file instead of sending it to the printer. @@ -4035,7 +4035,7 @@ image in a file with that name." "Process a PostScript file IFILENAME and send it to printer. Interactively, the command prompts for N-UP printing number, for an input -PostScript file IFILENAME and, when you use a prefix argument (C-u), the +PostScript file IFILENAME and, when you use a prefix argument (\\[universal-argument]), the command prompts the user for an output PostScript file name OFILENAME, and saves the PostScript image in that file instead of sending it to the printer. @@ -4280,18 +4280,18 @@ Interactively, you have the following situations: The command prompts the user for a N-UP value and printing will immediately be done using the current active printer. - C-u M-x pr-ps-fast-fire RET - C-u 0 M-x pr-ps-fast-fire RET + \\[universal-argument] \\[pr-ps-fast-fire] + \\[universal-argument] 0 \\[pr-ps-fast-fire] The command prompts the user for a N-UP value and also for a current PostScript printer, then printing will immediately be done using the new current active printer. - C-u 1 M-x pr-ps-fast-fire RET + \\[universal-argument] 1 \\[pr-ps-fast-fire] The command prompts the user for a N-UP value and also for a file name, and saves the PostScript image in that file instead of sending it to the printer. - C-u 2 M-x pr-ps-fast-fire RET + \\[universal-argument] 2 \\[pr-ps-fast-fire] The command prompts the user for a N-UP value, then for a current PostScript printer and, finally, for a file name. Then change the active printer to that chosen by user and saves the PostScript image in @@ -4360,7 +4360,7 @@ Also if the current major-mode is defined in `pr-mode-alist', the settings in `pr-mode-alist' will be used, that is, the current buffer or region will be printed using `pr-txt-mode'. -Interactively, when you use a prefix argument (C-u), the command prompts the +Interactively, when you use a prefix argument (\\[universal-argument]), the command prompts the user for a new active text printer. Noninteractively, the argument SELECT-PRINTER is treated as follows: diff --git a/lisp/progmodes/idlwave.el b/lisp/progmodes/idlwave.el index ce984d32b5..374876d5b4 100644 --- a/lisp/progmodes/idlwave.el +++ b/lisp/progmodes/idlwave.el @@ -5727,10 +5727,10 @@ Possible values are: 8 <=> `function-method-keyword' 9 <=> `class' -As a special case, the universal argument C-u forces completion of +As a special case, the universal argument \\[universal-argument] forces completion of function names in places where the default would be a keyword. -Two prefix argument, C-u C-u, prompts for a regexp by which to limit +Two prefix argument, \\[universal-argument] \\[universal-argument], prompts for a regexp by which to limit completion. For Lisp programmers only: diff --git a/lisp/progmodes/sh-script.el b/lisp/progmodes/sh-script.el index 201d1fd164..cccd70f06c 100644 --- a/lisp/progmodes/sh-script.el +++ b/lisp/progmodes/sh-script.el @@ -2193,7 +2193,7 @@ Point should be before the newline." When used interactively, insert the proper starting #!-line, and make the visited file executable via `executable-set-magic', perhaps querying depending on the value of `executable-query'. -(If given a prefix (i.e., `C-u') don't insert any starting #! +(If given a prefix (i.e., `\\[universal-argument]') don't insert any starting #! line.) When this function is called noninteractively, INSERT-FLAG (the third diff --git a/lisp/replace.el b/lisp/replace.el index dfb0a63d1a..e4155d4c27 100644 --- a/lisp/replace.el +++ b/lisp/replace.el @@ -1760,7 +1760,7 @@ If REGEXP contains upper case characters (excluding those preceded by `\\') and `search-upper-case' is non-nil, the matching is case-sensitive. When NLINES is a string or when the function is called -interactively with prefix argument without a number (`C-u' alone +interactively with prefix argument without a number (\\[universal-argument] alone as prefix) the matching strings are collected into the `*Occur*' buffer by using NLINES as a replacement regexp. NLINES may contain \\& and \\N which convention follows `replace-match'. diff --git a/lisp/ses.el b/lisp/ses.el index b831cbb548..9250f7ede0 100644 --- a/lisp/ses.el +++ b/lisp/ses.el @@ -3124,13 +3124,13 @@ Otherwise the text is inserted as the formula for the current cell. When inserting cells, the formulas are usually relocated to keep the same relative references to neighboring cells. This is best if the formulas -generally refer to other cells within the yanked text. You can use the C-u +generally refer to other cells within the yanked text. You can use the \\[universal-argument] prefix to specify insertion without relocation, which is best when the formulas refer to cells outside the yanked text. When inserting formulas, the text is treated as a string constant if it doesn't make sense as a sexp or would otherwise be considered a symbol. Use `sym' to -explicitly insert a symbol, or use the C-u prefix to treat all unmarked words +explicitly insert a symbol, or use the \\[universal-argument] prefix to treat all unmarked words as symbols." (if (not (and (derived-mode-p 'ses-mode) (eq (get-text-property (point) 'keymap) 'ses-mode-print-map))) diff --git a/lisp/simple.el b/lisp/simple.el index 13a0d2196a..1267c92fe5 100644 --- a/lisp/simple.el +++ b/lisp/simple.el @@ -6511,13 +6511,13 @@ Display `Mark set' unless the optional second arg NOMSG is non-nil." (defcustom set-mark-command-repeat-pop nil "Non-nil means repeating \\[set-mark-command] after popping mark pops it again. -That means that C-u \\[set-mark-command] \\[set-mark-command] +That means that \\[universal-argument] \\[set-mark-command] \\[set-mark-command] will pop the mark twice, and -C-u \\[set-mark-command] \\[set-mark-command] \\[set-mark-command] +\\[universal-argument] \\[set-mark-command] \\[set-mark-command] \\[set-mark-command] will pop the mark three times. A value of nil means \\[set-mark-command]'s behavior does not change -after C-u \\[set-mark-command]." +after \\[universal-argument] \\[set-mark-command]." :type 'boolean :group 'editing-basics) diff --git a/lisp/sort.el b/lisp/sort.el index 72df83aaff..be373fba99 100644 --- a/lisp/sort.el +++ b/lisp/sort.el @@ -587,16 +587,16 @@ is the one that ends before END." Non-interactively, arguments BEG and END delimit the region. Normally it searches forwards, keeping the first instance of each identical line. If REVERSE is non-nil (interactively, with -a C-u prefix), it searches backwards and keeps the last instance of +a \\[universal-argument] prefix), it searches backwards and keeps the last instance of each repeated line. Identical lines need not be adjacent, unless the argument -ADJACENT is non-nil (interactively, with a C-u C-u prefix). +ADJACENT is non-nil (interactively, with a \\[universal-argument] \\[universal-argument] prefix). This is a more efficient mode of operation, and may be useful on large regions that have already been sorted. If the argument KEEP-BLANKS is non-nil (interactively, with a -C-u C-u C-u prefix), it retains repeated blank lines. +\\[universal-argument] \\[universal-argument] \\[universal-argument] prefix), it retains repeated blank lines. Returns the number of deleted lines. Interactively, or if INTERACTIVE is non-nil, it also prints a message describing the number of deletions." diff --git a/lisp/strokes.el b/lisp/strokes.el index 18595cb094..91ddefd373 100644 --- a/lisp/strokes.el +++ b/lisp/strokes.el @@ -928,13 +928,13 @@ cycle can continue. To toggle strokes-mode, invoke the command -> M-x strokes-mode +> \\[strokes-mode] ** Strokes for controlling the behavior of Emacs... When you're ready to start defining strokes, just use the command -> M-x strokes-global-set-stroke +> \\[strokes-global-set-stroke] You will see a ` *strokes*' buffer which is waiting for you to enter in your stroke. When you enter in the stroke, you draw with button 1 or @@ -943,7 +943,7 @@ which will be executed when that stroke is invoked. Simple as that. For now, try to define a stroke to copy a region. This is a popular edit command, so type -> M-x strokes-global-set-stroke +> \\[strokes-global-set-stroke] Then, in the ` *strokes*' buffer, draw the letter `C' (for `copy') and then, when it asks you to enter the command to map that to, type @@ -955,7 +955,7 @@ Remember: paint with button 1 or button 2 and then end with button 3. If ever you want to know what a certain strokes maps to, then do -> M-x strokes-describe-stroke +> \\[strokes-describe-stroke] and you can enter in any arbitrary stroke. Remember: The strokes package lets you program in simple and complex (multi-lift) strokes. @@ -967,12 +967,12 @@ will invoke the command `strokes-do-stroke'. If ever you define a stroke which you don't like, then you can unset it with the command -> M-x strokes-unset-last-stroke +> \\[strokes-unset-last-stroke] You can always get an idea of what your current strokes look like with the command -> M-x strokes-list-strokes +> \\[strokes-list-strokes] Your strokes will be displayed in alphabetical order (based on command names) and the beginning of each simple stroke will be marked by a @@ -981,19 +981,19 @@ stroke, the dot colors are arranged in the rainbow color sequence, `ROYGBIV'. If you want a listing of your strokes from most recent down, then use a prefix argument: -> C-u M-x strokes-list-strokes +> \\[universal-argument] \\[strokes-list-strokes] Your strokes are stored as you enter them. They get saved into the file specified by the `strokes-file' variable, along with other strokes configuration variables. You will be prompted to save them when you exit Emacs, or you can save them with -> M-x strokes-prompt-user-save-strokes +> \\[strokes-prompt-user-save-strokes] Your strokes get loaded automatically when you enable `strokes-mode'. You can also load in your user-defined strokes with -> M-x strokes-load-user-strokes +> \\[strokes-load-user-strokes] ** Strokes for pictographic editing... @@ -1006,11 +1006,11 @@ into the buffer. You treat it somewhat like any other character, which you can copy, paste, delete, move, etc. When all is done, you may want to send the file, or save it. This is done with -> M-x strokes-encode-buffer +> \\[strokes-encode-buffer] Likewise, to decode the strokes from a strokes-encoded buffer you do -> M-x strokes-decode-buffer +> \\[strokes-decode-buffer] ** A few more important things... diff --git a/lisp/textmodes/artist.el b/lisp/textmodes/artist.el index 5e706327ed..c42286e5bc 100644 --- a/lisp/textmodes/artist.el +++ b/lisp/textmodes/artist.el @@ -1277,7 +1277,7 @@ Drawing with keys \\[artist-key-set-point] Does one of the following: For lines/rectangles/squares: sets the first/second endpoint - For poly-lines: sets a point (use C-u \\[artist-key-set-point] to set last point) + For poly-lines: sets a point (use \\[universal-argument] \\[artist-key-set-point] to set last point) When erase characters: toggles erasing When cutting/copying: Sets first/last endpoint of rect/square When pasting: Pastes diff --git a/lisp/textmodes/reftex-cite.el b/lisp/textmodes/reftex-cite.el index 4ca0a5bba8..8a54b1a301 100644 --- a/lisp/textmodes/reftex-cite.el +++ b/lisp/textmodes/reftex-cite.el @@ -628,7 +628,7 @@ If NO-INSERT is non-nil, nothing is inserted, only the selected key returned. FORMAT-KEY can be used to pre-select a citation format. -When called with a `C-u' prefix, prompt for optional arguments in +When called with a \\[universal-argument] prefix, prompt for optional arguments in cite macros. When called with a numeric prefix, make that many citations. When called with point inside the braces of a `\\cite' command, it will add another key, ignoring the value of diff --git a/lisp/textmodes/reftex-dcr.el b/lisp/textmodes/reftex-dcr.el index a21dd3362b..abcf119fb8 100644 --- a/lisp/textmodes/reftex-dcr.el +++ b/lisp/textmodes/reftex-dcr.el @@ -42,7 +42,7 @@ 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 C-u prefixes, enforce rescanning of the document. +With one or two \\[universal-argument] prefixes, enforce rescanning of the document. With argument 2, select the window showing the cross reference. AUTO-HOW is only for the automatic crossref display and is handed through to the functions `reftex-view-cr-cite' and `reftex-view-cr-ref'." diff --git a/lisp/textmodes/reftex-index.el b/lisp/textmodes/reftex-index.el index cba514ea55..a6df4fb7af 100644 --- a/lisp/textmodes/reftex-index.el +++ b/lisp/textmodes/reftex-index.el @@ -38,8 +38,8 @@ "Put selection or the word near point into the default index macro. This uses the information in `reftex-index-default-macro' to make an index entry. The phrase indexed is the current selection or the word near point. -When called with one `C-u' prefix, let the user have a chance to edit the -index entry. When called with 2 `C-u' as prefix, also ask for the index +When called with one \\[universal-argument] prefix, let the user have a chance to edit the +index entry. When called with 2 \\[universal-argument] as prefix, also ask for the index macro and other stuff. When called inside TeX math mode as determined by the `texmathp.el' library which is part of AUCTeX, the string is first processed with the @@ -462,7 +462,7 @@ _ ^ Add/Remove parent key (to make this item a subitem). "Display a buffer with an index compiled from the current document. When the document has multiple indices, first prompts for the correct one. When index support is turned off, offer to turn it on. -With one or two `C-u' prefixes, rescan document first. +With one or two \\[universal-argument] prefixes, rescan document first. With prefix 2, restrict index to current document section. With prefix 3, restrict index to region." diff --git a/lisp/textmodes/reftex-ref.el b/lisp/textmodes/reftex-ref.el index 1908182593..9d5bc5a8f0 100644 --- a/lisp/textmodes/reftex-ref.el +++ b/lisp/textmodes/reftex-ref.el @@ -415,7 +415,7 @@ reftex-label. Rescanning of the buffer can also be requested from the label selection menu. The function returns the selected label or nil. If NO-INSERT is non-nil, do not insert \\ref command, just return label. -When called with 2 C-u prefix args, disable magic word recognition." +When called with 2 \\[universal-argument] prefix args, disable magic word recognition." (interactive) diff --git a/lisp/textmodes/reftex-toc.el b/lisp/textmodes/reftex-toc.el index b564349133..7ca2fb827e 100644 --- a/lisp/textmodes/reftex-toc.el +++ b/lisp/textmodes/reftex-toc.el @@ -180,7 +180,7 @@ z Jump to a specific section (e.g. '3 z' goes to section 3).") (defun reftex-toc (&optional _rebuild reuse) ;; FIXME: Get rid of the `rebuild' argument. "Show the table of contents for the current document. -When called with a raw C-u prefix, rescan the document first." +When called with a raw \\[universal-argument] prefix, rescan the document first." ;; The REUSE argument means, search all visible frames for a window ;; displaying the toc window. If yes, reuse this window. diff --git a/lisp/textmodes/reftex-vars.el b/lisp/textmodes/reftex-vars.el index 19b40e6ce2..23f2193501 100644 --- a/lisp/textmodes/reftex-vars.el +++ b/lisp/textmodes/reftex-vars.el @@ -1292,7 +1292,7 @@ prompt for values. Possible values are: nil Never prompt for optional arguments t Always prompt -maybe Prompt only if `reftex-citation' was called with C-u prefix arg +maybe Prompt only if `reftex-citation' was called with \\[universal-argument] prefix arg Unnecessary empty optional arguments are removed before insertion into the buffer. See `reftex-cite-cleanup-optional-args'." @@ -1861,11 +1861,11 @@ of the regular expressions in this list, that file is not parsed by RefTeX." (defcustom reftex-enable-partial-scans nil "Non-nil means, re-parse only 1 file when asked to re-parse. -Re-parsing is normally requested with a `C-u' prefix to many RefTeX commands, +Re-parsing is normally requested with a \\[universal-argument] prefix to many RefTeX commands, or with the `r' key in menus. When this option is t in a multifile document, we will only parse the current buffer, or the file associated with the label or section heading near point in a menu. Requesting re-parsing of an entire -multifile document then requires a `C-u C-u' prefix or the capital `R' key +multifile document then requires a \\[universal-argument] \\[universal-argument] prefix or the capital `R' key in menus." :group 'reftex-optimizations-for-large-documents :type 'boolean) diff --git a/lisp/textmodes/texnfo-upd.el b/lisp/textmodes/texnfo-upd.el index f56f197c50..843bbb2bca 100644 --- a/lisp/textmodes/texnfo-upd.el +++ b/lisp/textmodes/texnfo-upd.el @@ -894,10 +894,10 @@ be updated first using `texinfo-make-menu' or `texinfo-all-menus-update', which see. Alternatively, invoke this function with a prefix argument, see below. -Non-nil, non-numeric argument (C-u prefix, if interactive) means +Non-nil, non-numeric argument (\\[universal-argument] prefix, if interactive) means first update all existing menus in the buffer (incorporating descriptions from pre-existing menus) before it constructs the -master menu. If the argument is numeric (e.g., \"C-u 2\"), +master menu. If the argument is numeric (e.g., \"\\[universal-argument] 2\"), update all existing nodes as well, by calling `texinfo-update-node' on the entire file. Warning: do NOT invoke with a numeric argument if your Texinfo file uses @node diff --git a/lisp/windmove.el b/lisp/windmove.el index bb0ece7cba..658e59af19 100644 --- a/lisp/windmove.el +++ b/lisp/windmove.el @@ -525,7 +525,7 @@ to decide what window it selects. With other non-nil values of `windmove-display-no-select', this function reselects a previously selected old window. -If prefix ARG is `C-u', reselect a previously selected old window. +If prefix ARG is \\[universal-argument], reselect a previously selected old window. If `windmove-display-no-select' is non-nil, the meaning of the prefix argument is reversed and it selects the new window. @@ -662,7 +662,7 @@ from the opposite side of the frame." ;;;###autoload (defun windmove-delete-left (&optional arg) "Delete the window to the left of the current one. -If prefix ARG is `C-u', delete the selected window and +If prefix ARG is \\[universal-argument], delete the selected window and select the window that was to the left of the current one." (interactive "P") (windmove-delete-in-direction 'left arg)) @@ -670,7 +670,7 @@ select the window that was to the left of the current one." ;;;###autoload (defun windmove-delete-up (&optional arg) "Delete the window above the current one. -If prefix ARG is `C-u', delete the selected window and +If prefix ARG is \\[universal-argument], delete the selected window and select the window that was above the current one." (interactive "P") (windmove-delete-in-direction 'up arg)) @@ -678,7 +678,7 @@ select the window that was above the current one." ;;;###autoload (defun windmove-delete-right (&optional arg) "Delete the window to the right of the current one. -If prefix ARG is `C-u', delete the selected window and +If prefix ARG is \\[universal-argument], delete the selected window and select the window that was to the right of the current one." (interactive "P") (windmove-delete-in-direction 'right arg)) @@ -686,7 +686,7 @@ select the window that was to the right of the current one." ;;;###autoload (defun windmove-delete-down (&optional arg) "Delete the window below the current one. -If prefix ARG is `C-u', delete the selected window and +If prefix ARG is \\[universal-argument], delete the selected window and select the window that was below the current one." (interactive "P") (windmove-delete-in-direction 'down arg)) diff --git a/lisp/window.el b/lisp/window.el index a25da0ff1b..b240b16f24 100644 --- a/lisp/window.el +++ b/lisp/window.el @@ -9770,7 +9770,7 @@ tool-bar's height to the minimum height needed); if `recenter-redisplay' has the special value `tty', then only tty frames are redrawn. -Just C-u as prefix means put point in the center of the window +Just \\[universal-argument] as prefix means put point in the center of the window and redisplay normally--don't erase and redraw the frame." (if (functionp recenter-window-group-function) (funcall recenter-window-group-function arg) @@ -9899,7 +9899,7 @@ With plain \\[universal-argument], move current line to window center." A prefix argument is handled like `recenter': With numeric prefix ARG, move current line to window-line ARG. - With plain `C-u', move current line to window center." + With plain \\[universal-argument], move current line to window center." (interactive "P") (with-selected-window (other-window-for-scrolling) (recenter-top-bottom arg) commit 63f419f1339cbd0a7d1e64586854a4f01b3f80d1 Author: Stefan Kangas Date: Tue Sep 14 08:43:18 2021 +0200 ; Minor stylistic fixes found by checkdoc diff --git a/etc/themes/manoj-dark-theme.el b/etc/themes/manoj-dark-theme.el index e3df40ebe9..0e5fb39119 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 a8577108ed..1a33676eba 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 286561eb4e..9ee2619ce2 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 a0b626a5c4..2f380a8077 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 0e12704088..668e7b91e8 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 622596310b..09977aae84 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 79dc821ea1..79b1c9912f 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 a1470537d9..513175d751 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 71ad7bd0c5..5576ae3505 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 6919738398..8d6ebd39dc 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 9197eadf22..c8fe205946 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 b8bf0c1a6f..4dfc9a908c 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 0a079482ca..56aec1c4f9 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 db4751a9fb..0e913ddfdb 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 503ed77702..a1f4ca43e7 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 45337e187b..dbe2f689d8 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 16a2bd89ca..d12d05f305 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 516f62d7b6..eed20a89a4 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 b573c53f41..c8394e8c2f 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 8b6f063703..fd6f3a7b67 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 800ec7a6a3..afb43c0f33 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 99c9b6290c..415e0b4c77 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 7b55d420c3..75e106cb37 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 eaee2e9d95..312d5e2f38 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 371d10631c..68e29d4cec 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 ee9d0116af..da6a3f3e90 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 652d6476f0..fd37e53ed4 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 d696594549..709963d6fa 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 7e0f5a8934..7a3b36f30f 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 c8c34d092f..1352e5c193 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 258917f01b..e7f5640c07 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 5dbad4fcc0..338b03d25d 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 247f78ecff..02d69a1686 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 fb443fa4a3..205d6a812a 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 ccf405d62e..1e8cd9af08 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 e7ecb61513..c7d59def1f 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 47850a5d1f..64ccbb4519 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 5d34b308d0..6cfbdd5f03 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 41e48b0bc3..c9ae68e9fa 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 c96a426280..61baaa020f 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 c0fee3b2bd..03158171a2 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 4f96746166..c13952265e 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 389b3062c5..ae2895c2b9 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 19d4184fa4..9a4d412d5d 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 4ad70ff7c6..16e8ce8de9 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 4c3bb6c238..33c66da9a6 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 c058e8a8b5..b1805f720d 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 e06a3c1007..53745b429a 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 2e447bbc58..b1b36132b3 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 b6386d71db..a86ed020bb 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 106862837a..5ce1108044 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 c49237b94c..fe887c281c 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 5da045e17f..d6dfc58411 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 101246cae6..fbb6984dc1 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 18087da9ac..0910ea6187 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 02878cc641..56d4420e60 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 93a869e86f..e36c722841 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 6f654df15a..a16c0cc237 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 1153961468..ac78e568da 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 f5e467d37e..7ab90d08ac 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 c728642917..53fbcfb6d0 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 9978d027a9..266a03e6cc 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 a0ffcac9f8..0896bd13eb 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 e0a533c637..07c77faa23 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 e18aad1c3f..8ee413acd0 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 d8c377a2ef..82db8dbfc7 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 aca5dcba62..6d698ffb6f 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 54f881bde8..b662049960 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 a723dbdbb9..8a42f89315 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 56202c7fff..4500faae57 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 728f790a96..c3b36f10ae 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 55930e7e6b..e93666956c 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 4a9070e84b..75b627ea6a 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 83fc5afafa..98b123a7f4 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 cce5117433..6ba265f8ab 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 9ad952c681..99a432c236 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 2698b39ffe..ed1dae3e8a 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 1a13aa95cd..bbab37fd5d 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 fc72f324eb..4e9547dfde 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 31e59a6d3e..95eab04044 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 43fbca3e66..fb50e84f65 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 9cfb947003..994f2d07c3 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 ca0e90e984..1c7742afd2 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 8ea37c7f29..43330755a8 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 3f69c4cb9c..90c0ee6f8a 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 666fd58592..52285a8343 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 92759d206a..e835c45af8 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 950a821e3c..ddfaafb048 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 a75a74bb6f..a6ad856bfd 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 2582a5039a..eb2a9712ac 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 ff33fbc557..2c4002f0ee 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 e1b9f0de3a..c17eb59da3 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 60168d42f9..d08796a78d 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 0e6121031d..c2471912ab 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 1b722014f8..deeec8c59d 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 5914ee4a20..c84742be5a 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 84dcc04a71..b6e419b2d6 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 4fc7f0a8ec..a0c3758238 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 3055226ba2..3a397f812e 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 d138675066..63f0e8ba3f 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 4fd4f4e06b..4d520c01cc 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 2f43293603..6062bd2643 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 c00a62a160..a4ab897f6f 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 46f4df9b6c..e1de011133 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 cbe3505cd1..961965d928 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 c4fa1e960b..7076dbedf2 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 e2cbca9007..7ecc97262a 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 af0b782202..e9eddae942 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 5294b83d9e..b6e5e7f786 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 01053797b3..255c11f137 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 3b2b5a07c1..ee3abf2f7b 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 6adda2ed14..878e879cd7 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 863b6aa44e..66501ef7d5 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 0468d72edd..9b76f98322 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 5b746a8efa..dc81dfc5f6 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 f40da9e9c4..0626e8bde5 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 2a8069d400..9c83d5fa37 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 eeedf7ff35..d173decbb6 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 1c75abb6f4..115efa9805 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 4bbeb24dc3..1c2e9ebd91 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 c28e38e315..f17bb11e6a 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 70ae81d95e..fb285962d6 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 6c926384c9..f7b761ee33 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 5009507208..0505e33cb6 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 a7219ede94..ffbead3398 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 d2066a05f7..551cf7e1a3 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 3b048ba650..4a7bf9479a 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 4fadbbe418..9720709038 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 907ee8d63f..7c95baf8cd 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 0fa5f36734..01033474d3 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 b81a9db5eb..7c2d2eb0d7 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 192530a8e6..b18dd841fc 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 69ef7015cc..4a326cdc69 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 494c26a8a3..6e1dbbdf5c 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 bac09752b7..b552e8532a 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 54dca60951..a877722f4e 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 ead7c8aa61..f0bfe9f682 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 ff7cddcb26..9449b3bb85 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 1a53237f14..ee116976ea 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 5d1311530a..c0e53d26fb 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 f1fb6c1dda..6b5abcbd7c 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 fdab7e5a50..25f1f300f3 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 8821e35c2d..a39f433cdc 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 8d4b2a826e..6f579f2383 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 5d0389c28d..d12064958e 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 ddf4a0c0fb..1f7a1edcad 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 207d76f47c..d380630c0a 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 6c9b2d99cc..0f0bae9eca 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 faccc0afc5..57e0dfd820 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 158c02ecea..0ea441de01 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 c4dbe2af02..008d65e055 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 9041b9ac0f..8e81f79e42 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 faa1f0bd35..689c4210cd 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 f380f0df29..23fddfd167 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 083d8feae4..608062fba4 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 b765602281..716348a9c1 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 5cb4a7469a..62d9b12bb2 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 5c153ce1c1..e6833806d9 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 6d83414058..a36ccd98dc 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 4b70582a26..2983a11d74 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 fbac9e0cc0..75a6c72369 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 8a38337773..9fbc9ba180 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 4c23686909..91f86a234d 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 d545b0c3f1..f393ac773f 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 8def1575b2..d863f34df1 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 8b798926c1..b3adbf0017 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 30273fab1b..f67ec353c8 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 14fbb51b27..38c85064f3 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 029f0ca8f4..1f4cb4fe9c 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 c51766d168..25ae20702a 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 bf77ecc7af..b21c66ef14 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 4947caba69..85467cd782 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 517913ff01..5c451c6556 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 28569eeeb1..c1202974f4 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 43dd9dc15c..7b1ea2e765 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 78f6f3d915..848bad3b0d 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 7997bf3c90..8b63dce211 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 5473ba7e69..83d0eeef9f 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 1d9ee6db86..2ac1df1d58 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 2574c8cb63..046953faf6 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 4022a35b39..2427f4976e 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 5afc195d4b..3696f526b5 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 4102b9d322..4217c219ad 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 eb78a259a8..aa92c365f8 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 85d81b6bbc..a8e15c1e0a 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 1f08a15e57..64544bcf15 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 0e8fdc0a90..70cebd3039 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 6d571a0a30..99bc0a7acd 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 ae878ef3a5..10892ebf61 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 78a261fd83..7ac8bbbf1b 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 bb65ecaa98..9aa5d50d6c 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 22d4712985..0416d15f52 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 6ed67034f4..93ec8d6934 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 d5da73bd85..98be0e0158 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 b458f0356d..52e7f09b69 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 ebd74dd3ef..c1b83dc155 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 405f803325..c5c9dfb2af 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 e33140c0a4..93ffb215fb 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 c265b19cf0..681b297b48 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 6f742746e9..fa127da874 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 d70a346159..35faae3062 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 a5eb893c55..fca666115a 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 9941aba6eb..e4c76b220a 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 38bc2e141e..6159e00c51 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 78b8259b39..249484cf58 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 64d43c3d48..1d19330629 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 be35daf4da..d1bf45ed51 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 a80cb21151..5431d7f068 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 332e743ed8..d9acad8e43 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 fb02edffe7..f13302525b 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 8b64dfdf9b..49a0c9ee02 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 c6aef027e5..cc9a6b7a4f 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 2aec408e11..d59352c352 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 ac28fba10a..d3d0ad1309 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 2abf8ccb74..2bf7292772 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 123cc3cfac..5ac1d7c60c 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 d0669eb1f4..69f444994f 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 19e4e399ff..27aa48f4c9 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 4ca5886bf1..bcca637e00 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 7587676ab2..32ff51a511 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 2fafdcc58e..fec2a29c84 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 4c427692cb..0b456bb3e3 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 9234d0b19b..a26c1d5bff 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 f1bc25db7f..ea99101750 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 edbac64ead..f07f18678a 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 bdfdf178d4..217281b8a2 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 fe6ff220ba..be0b40fd6c 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 77da98f626..53c382f018 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 9c88c14a6c..8f46b17c54 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 0b125bc43f..b106454b11 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 a099ec1de9..52b47a5873 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 057d292246..c818c1a358 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 8514434e9a..c6b6be5b39 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 b33fea0b48..dcd9546d9a 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 1147889969..634dd29bad 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 93bae5a33c..9185711848 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 5d8541931e..ae48881ee9 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 55325ef488..d40ae476a6 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 cddf3ba0b9..e6af2b12c7 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 5c0b7880e8..3f2c9b7148 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 907300eb27..3ae3fcb9fe 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 9cbad121d1..27b46a45c5 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 fb612eebc7..e8ce0e723e 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 707226fb2a..7cf4ce2730 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 41384e129b..902466e4fe 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 b2a9b3e320..d7f4582dd0 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 d8c77f7f23..2061d41480 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 7cd49a69d4..a18a67249a 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 6d2d402e35..bf49c92552 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 b90bbedd45..ffa3d78b4d 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 f2bfbf3e37..fc3d603f06 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 d3f47fcf45..c3ffcd18ce 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 91be401623..ce984d32b5 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 c2481f6095..845ca8609d 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 485e64e249..879eb72065 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 b1a5f30158..6bf070cf9e 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 662d2b4b74..51c888d25f 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 4e14c30bc5..20834dd2e1 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 2e23c2e2ca..33ca01cc75 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 67c034d090..68c3cd91fa 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 19b79b6919..f848f4c103 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 6a03856eaf..b0b055bd36 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 d144d68b57..02eccb3301 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 f6a50bf1a8..b6a7a20d87 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 2b5f85df2f..ef2c21da45 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 3fe67fabf1..fef7dff65e 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 0f7a519497..ab7e8f6e29 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 c5a48f59aa..38671b58e2 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 11d98482cb..e48a09f157 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 258f7fc904..c10ae91d16 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 947da8a2fe..dfb0a63d1a 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 378358feac..3c1958686f 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 166c780818..0eaaa58e6e 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 8225588b9d..4191a3fa62 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 ac5db197f3..5dd30db195 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 cc8c35d699..b831cbb548 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 14e5abc87d..13a0d2196a 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 c39c3ecaf3..0cc6e884b8 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 0d2fd41664..72df83aaff 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 b80d1c2838..a2266b1d57 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 ec36f54378..e9de31f50d 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 599fe74316..5abc25b203 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 411c71cd8c..db655619be 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 87e274a527..25f54af3c9 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 0bcd095283..caa3b39be4 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 af1e388c2a..1a3811a37c 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 3dfd4c697a..4c88c80bf7 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 8c6c75e7e2..d6e6318748 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 95187d5d11..52a64d6c41 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 d9a83c566b..5e706327ed 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 d5671ce14f..237a1d9935 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 57ec8a0428..30f8fd0ca9 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 f394171fb6..81d908c95e 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 0d95b4c115..5842bf5f9f 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 a9b7b6dc96..cb7f275ea6 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 a2b745b0af..4ca0a5bba8 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 5674d31c81..cba514ea55 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 1278e4c403..c926b05634 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 50e44ff636..fef5ad2c7a 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 977f3bab6c..604a67df32 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 8782c9eeb5..0af6d56ccc 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 9f25f99a14..8496adec22 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 5f441e80dd..2be82f56d8 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 ba13a17a8f..c4a29ebe10 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 492907f33f..f2e9b4c4a1 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 113ac2833b..7ffccfd3a0 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 2aa2e7912f..f0d70ff6e7 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 5afc83d9e2..1d87b081f2 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 9e82392725..0646ba3cc2 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 8f7affeea4..b363fa256b 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 ec6dc282dc..6f921ac2a0 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 1785440d53..fe631ee09a 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 26cea0001c..ebecdff62e 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 bac0069b85..8f62b5757a 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 fd549bac32..eafb50cc18 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 b72f548f50..393fe6c21b 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 47a1668ee8..bb0ece7cba 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 3b897eb0ba..a25da0ff1b 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 8062fbae90..1b2807f248 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 e5165bbd86..1f9fa6795e 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 1b2d655738..0282e3741c 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 72faff8101..e4e91aa892 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 2a42d5636d..2dcfb1c309 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 5c6af9b45c..b05a9629c1 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 1c4bd8d36d..45482e916e 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 1561c18dd6..044db29cda 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 commit 36474a1e490a5eae266805a0e04615741d56692c Author: Michael Albinus Date: Thu Sep 16 16:50:24 2021 +0200 Tramp code cleanup * lisp/net/tramp-sh.el (tramp-methods) : Reintroduce "%n" marker. (tramp-maybe-open-connection): Handle it. * lisp/net/tramp.el (tramp-prefix-regexp): * lisp/net/tramp-smb.el (tramp-smb-options): Fix docstring. * lisp/net/tramp*.el: Fix typos. Remove trailing space from `yes-or-no-p' and `y-or-n-p' prompts. * test/lisp/net/tramp-tests.el (tramp--test-telnet-p): New defun. (tramp-test29-start-file-process, tramp-test30-make-process) (tramp-test35-remote-path, tramp-test44-asynchronous-requests): Adapt tests. diff --git a/lisp/net/tramp-adb.el b/lisp/net/tramp-adb.el index a35ac37a20..46064a8574 100644 --- a/lisp/net/tramp-adb.el +++ b/lisp/net/tramp-adb.el @@ -361,7 +361,7 @@ arguments to pass to the OPERATION." (tramp-message vec 5 "Finding a suitable `ls' command") (cond ;; Support Android derived systems where "ls" command is provided - ;; by GNU Coreutils. Force "ls" to print one column and set + ;; by GNU Coreutils. Force "ls" to print one column and set ;; time-style to imitate other "ls" flavors. ((tramp-adb-send-command-and-check vec (concat "ls --time-style=long-iso " @@ -548,7 +548,7 @@ But handle the case, if the \"test\" command is not available." (or (eq mustbenew 'excl) (not (y-or-n-p - (format "File %s exists; overwrite anyway? " filename))))) + (format "File %s exists; overwrite anyway?" filename))))) (tramp-error v 'file-already-exists filename)) (let ((file-locked (eq (file-locked-p lockname) t)) diff --git a/lisp/net/tramp-archive.el b/lisp/net/tramp-archive.el index 67798e892a..5e2e1f0602 100644 --- a/lisp/net/tramp-archive.el +++ b/lisp/net/tramp-archive.el @@ -190,7 +190,7 @@ It must be supported by libarchive(3).") ;; In older Emacsen (prior 27.1), `tramp-archive-autoload-file-name-regexp' ;; is not autoloaded. So we cannot expect it to be known in -;; tramp-loaddefs.el. But it exists, when tramp-archive.el is loaded. +;; tramp-loaddefs.el. But it exists, when tramp-archive.el is loaded. ;;;###tramp-autoload (defconst tramp-archive-file-name-regexp (ignore-errors (tramp-archive-autoload-file-name-regexp)) diff --git a/lisp/net/tramp-cmds.el b/lisp/net/tramp-cmds.el index 6278fd302a..bfd928731a 100644 --- a/lisp/net/tramp-cmds.el +++ b/lisp/net/tramp-cmds.el @@ -312,7 +312,7 @@ The remote connection identified by SOURCE is flushed by (if (null connections) (tramp-user-error nil "There are no remote connections.") (setq source - ;; Likely, the source remote connection is broken. So we + ;; Likely, the source remote connection is broken. So we ;; shall avoid any action on it. (let (non-essential) (completing-read-default @@ -717,7 +717,7 @@ the debug buffer(s).") (setq buffer-read-only t) (goto-char (point-min)) - (when (y-or-n-p "Do you want to append the buffer(s)? ") + (when (y-or-n-p "Do you want to append the buffer(s)?") ;; OK, let's send. First we delete the buffer list. (kill-buffer nil) (switch-to-buffer curbuf) diff --git a/lisp/net/tramp-crypt.el b/lisp/net/tramp-crypt.el index fdb2907ec3..5f86767ef9 100644 --- a/lisp/net/tramp-crypt.el +++ b/lisp/net/tramp-crypt.el @@ -517,7 +517,7 @@ kept in their encrypted form." tramp-crypt-encfs-config (directory-files name nil directory-files-no-dot-files-regexp)) (yes-or-no-p - "There exist encrypted files, do you want to continue? ")) + "There exist encrypted files, do you want to continue?")) (setq tramp-crypt-directories (delete name tramp-crypt-directories)) (tramp-register-file-name-handlers))) diff --git a/lisp/net/tramp-ftp.el b/lisp/net/tramp-ftp.el index fa2df89e49..11ccdc8a4c 100644 --- a/lisp/net/tramp-ftp.el +++ b/lisp/net/tramp-ftp.el @@ -120,15 +120,15 @@ pass to the OPERATION." (nth 2 tramp-file-name-structure) (nth 4 tramp-file-name-structure))) ;; ange-ftp uses `ange-ftp-ftp-name-arg' and `ange-ftp-ftp-name-res' - ;; for optimization in `ange-ftp-ftp-name'. If Tramp wasn't active, + ;; for optimization in `ange-ftp-ftp-name'. If Tramp wasn't active, ;; there could be incorrect values from previous calls in case the - ;; "ftp" method is used in the Tramp file name. So we unset + ;; "ftp" method is used in the Tramp file name. So we unset ;; those values. (ange-ftp-ftp-name-arg "") (ange-ftp-ftp-name-res nil)) (cond ;; If argument is a symlink, `file-directory-p' and - ;; `file-exists-p' call the traversed file recursively. So we + ;; `file-exists-p' call the traversed file recursively. So we ;; cannot disable the file-name-handler this case. We set the ;; connection property "started" in order to put the remote ;; location into the cache, which is helpful for further diff --git a/lisp/net/tramp-gvfs.el b/lisp/net/tramp-gvfs.el index 25deead813..5f0e7bcd98 100644 --- a/lisp/net/tramp-gvfs.el +++ b/lisp/net/tramp-gvfs.el @@ -1815,10 +1815,8 @@ a downcased host name only." (message "%s" message) (pop-to-buffer (current-buffer))) (if (yes-or-no-p - (concat - (buffer-substring - (line-beginning-position) (point)) - " ")) + (buffer-substring + (line-beginning-position) (point))) 0 1))))) ;; When QUIT is raised, we shall return this @@ -1840,7 +1838,7 @@ a downcased host name only." (ignore-errors (let ((signal-name (dbus-event-member-name last-input-event)) (elt mount-info)) - ;; Jump over the first elements of the mount info. Since there + ;; Jump over the first elements of the mount info. Since there ;; were changes in the entries, we cannot access dedicated ;; elements. (while (stringp (car elt)) (setq elt (cdr elt))) @@ -1936,7 +1934,7 @@ a downcased host name only." :session tramp-gvfs-service-daemon tramp-gvfs-path-mounttracker tramp-gvfs-interface-mounttracker tramp-gvfs-listmounts)) nil) - ;; Jump over the first elements of the mount info. Since there + ;; Jump over the first elements of the mount info. Since there ;; were changes in the entries, we cannot access dedicated ;; elements. (while (stringp (car elt)) (setq elt (cdr elt))) diff --git a/lisp/net/tramp-sh.el b/lisp/net/tramp-sh.el index d0a340a5df..22d4712985 100644 --- a/lisp/net/tramp-sh.el +++ b/lisp/net/tramp-sh.el @@ -244,14 +244,14 @@ The string is used in `tramp-methods'.") (add-to-list 'tramp-methods `("telnet" (tramp-login-program "telnet") - (tramp-login-args (("%h") ("%p"))) + (tramp-login-args (("%h") ("%p") ("%n"))) (tramp-remote-shell ,tramp-default-remote-shell) (tramp-remote-shell-login ("-l")) (tramp-remote-shell-args ("-c")))) (add-to-list 'tramp-methods `("nc" (tramp-login-program "telnet") - (tramp-login-args (("%h") ("%p"))) + (tramp-login-args (("%h") ("%p") ("%n"))) (tramp-remote-shell ,tramp-default-remote-shell) (tramp-remote-shell-login ("-l")) (tramp-remote-shell-args ("-c")) @@ -1064,7 +1064,7 @@ component is used as the target of the symlink." (not (yes-or-no-p (format - "File %s already exists; make it a link anyway? " + "File %s already exists; make it a link anyway?" localname))))) (tramp-error v 'file-already-exists localname) (delete-file linkname))) @@ -1073,7 +1073,7 @@ component is used as the target of the symlink." ;; Right, they are on the same host, regardless of user, ;; method, etc. We now make the link on the remote - ;; machine. This will occur as the user that TARGET belongs to. + ;; machine. This will occur as the user that TARGET belongs to. (and (tramp-send-command-and-check v (format "cd %s" (tramp-shell-quote-argument cwd))) (tramp-send-command-and-check @@ -1825,7 +1825,7 @@ ID-FORMAT valid values are `string' and `integer'." (and (numberp ok-if-already-exists) (not (yes-or-no-p (format - "File %s already exists; make it a link anyway? " + "File %s already exists; make it a link anyway?" v2-localname))))) (tramp-error v2 'file-already-exists newname) (delete-file newname))) @@ -2231,7 +2231,7 @@ the uid and gid from FILENAME." ;; Save exit. (ignore-errors (delete-file tmpfile))))))))) - ;; Set the time and mode. Mask possible errors. + ;; Set the time and mode. Mask possible errors. (ignore-errors (when keep-date (tramp-compat-set-file-times @@ -2748,7 +2748,7 @@ the result will be a local, non-Tramp, file name." ;;; Remote commands: -;; We use BUFFER also as connection buffer during setup. Because of +;; We use BUFFER also as connection buffer during setup. Because of ;; this, its original contents must be saved, and restored once ;; connection has been setup. (defun tramp-sh-handle-make-process (&rest args) @@ -3269,7 +3269,7 @@ implementation will be used." (or (eq mustbenew 'excl) (not (y-or-n-p - (format "File %s exists; overwrite anyway? " filename))))) + (format "File %s exists; overwrite anyway?" filename))))) (tramp-error v 'file-already-exists filename)) (let ((file-locked (eq (file-locked-p lockname) t)) @@ -4000,7 +4000,7 @@ Returns the absolute file name of PROGNAME, if found, and nil otherwise. This function expects to be in the right *tramp* buffer." (with-current-buffer (tramp-get-connection-buffer vec) (let (result) - ;; Check whether the executable is in $PATH. "which(1)" does not + ;; Check whether the executable is in $PATH. "which(1)" does not ;; report always a correct error code; therefore we check the ;; number of words it returns. "SunOS 5.10" (and maybe "SunOS ;; 5.11") have problems with this command, we disable the call @@ -4904,6 +4904,8 @@ connection if a previous connection has died for some reason." (tramp-error vec 'file-error "`tramp-encoding-shell' not set")) (let* ((current-host tramp-system-name) (target-alist (tramp-compute-multi-hops vec)) + ;; Needed for `tramp-get-remote-null-device'. + (previous-hop nil) ;; We will apply `tramp-ssh-controlmaster-options' ;; only for the first hop. (options (tramp-ssh-controlmaster-options vec)) @@ -5016,6 +5018,8 @@ connection if a previous connection has died for some reason." hop 'tramp-login-args ?h (or l-host "") ?u (or l-user "") ?p (or l-port "") ?c (format-spec options (format-spec-make ?t tmpfile)) + ?n (concat + "2>" (tramp-get-remote-null-device previous-hop)) ?l (concat remote-shell " " extra-args " -i")) ;; A restricted shell does not allow "exec". (when r-shell '("&&" "exit" "||" "exit"))) @@ -5031,10 +5035,12 @@ connection if a previous connection has died for some reason." tramp-actions-before-shell (or connection-timeout tramp-connection-timeout)) (tramp-message - vec 3 "Found remote shell prompt on `%s'" l-host)) - ;; Next hop. - (setq options "" - target-alist (cdr target-alist))) + vec 3 "Found remote shell prompt on `%s'" l-host) + + ;; Next hop. + (setq options "" + target-alist (cdr target-alist) + previous-hop hop))) ;; Activate session timeout. (when (tramp-get-connection-property p "session-timeout" nil) diff --git a/lisp/net/tramp-smb.el b/lisp/net/tramp-smb.el index 5cfe874f00..fa5bce74bb 100644 --- a/lisp/net/tramp-smb.el +++ b/lisp/net/tramp-smb.el @@ -48,7 +48,7 @@ ;; Another guess. We might implement a better check later on. (tramp-case-insensitive t))))) -;; Add a default for `tramp-default-user-alist'. Rule: For the SMB method, +;; Add a default for `tramp-default-user-alist'. Rule: For the SMB method, ;; the anonymous user is chosen. ;;;###tramp-autoload (tramp--with-startup @@ -83,7 +83,7 @@ call, letting the SMB client use the default one." They are added to the `tramp-smb-program' call via \"--option '...'\". For example, if the deprecated SMB1 protocol shall be used, add to -this variable (\"client min protocol=NT1\") ." +this variable \"client min protocol=NT1\"." :group 'tramp :type '(repeat string) :version "28.1") @@ -376,7 +376,7 @@ arguments to pass to the OPERATION." (and (numberp ok-if-already-exists) (not (yes-or-no-p (format - "File %s already exists; make it a link anyway? " + "File %s already exists; make it a link anyway?" v2-localname))))) (tramp-error v2 'file-already-exists newname) (delete-file newname))) @@ -1247,7 +1247,7 @@ component is used as the target of the symlink." (and (numberp ok-if-already-exists) (not (yes-or-no-p (format - "File %s already exists; make it a link anyway? " + "File %s already exists; make it a link anyway?" localname))))) (tramp-error v 'file-already-exists localname) (delete-file linkname))) @@ -1526,7 +1526,7 @@ component is used as the target of the symlink." (tramp-error v 'file-error "Error while changing file's mode %s" filename)))))) -;; We use BUFFER also as connection buffer during setup. Because of +;; We use BUFFER also as connection buffer during setup. Because of ;; this, its original contents must be saved, and restored once ;; connection has been setup. (defun tramp-smb-handle-start-file-process (name buffer program &rest args) @@ -1603,7 +1603,7 @@ errors for shares like \"C$/\", which are common in Microsoft Windows." (or (eq mustbenew 'excl) (not (y-or-n-p - (format "File %s exists; overwrite anyway? " filename))))) + (format "File %s exists; overwrite anyway?" filename))))) (tramp-error v 'file-already-exists filename)) (let ((file-locked (eq (file-locked-p lockname) t)) @@ -1703,7 +1703,7 @@ If VEC has no cifs capabilities, exchange \"/\" by \"\\\\\"." localname))) -;; Share names of a host are cached. It is very unlikely that the +;; Share names of a host are cached. It is very unlikely that the ;; shares do change during connection. (defun tramp-smb-get-file-entries (directory) "Read entries which match DIRECTORY. @@ -2200,5 +2200,7 @@ Removes smb prompt. Returns nil if an error message has appeared." ;; ;; * Try to remove the inclusion of dummy "" directory. Seems to be at ;; several places, especially in `tramp-smb-handle-insert-directory'. +;; +;; * Keep a separate connection process per share. ;;; tramp-smb.el ends here diff --git a/lisp/net/tramp-sshfs.el b/lisp/net/tramp-sshfs.el index c5b84a6e4e..0019ac014f 100644 --- a/lisp/net/tramp-sshfs.el +++ b/lisp/net/tramp-sshfs.el @@ -292,7 +292,7 @@ arguments to pass to the OPERATION." (or (eq mustbenew 'excl) (not (y-or-n-p - (format "File %s exists; overwrite anyway? " filename))))) + (format "File %s exists; overwrite anyway?" filename))))) (tramp-error v 'file-already-exists filename)) (let ((file-locked (eq (file-locked-p lockname) t))) diff --git a/lisp/net/tramp-sudoedit.el b/lisp/net/tramp-sudoedit.el index 051d145c2a..516d46da37 100644 --- a/lisp/net/tramp-sudoedit.el +++ b/lisp/net/tramp-sudoedit.el @@ -190,7 +190,7 @@ arguments to pass to the OPERATION." (and (numberp ok-if-already-exists) (not (yes-or-no-p (format - "File %s already exists; make it a link anyway? " + "File %s already exists; make it a link anyway?" v2-localname))))) (tramp-error v2 'file-already-exists newname) (delete-file newname))) @@ -632,7 +632,7 @@ component is used as the target of the symlink." (not (yes-or-no-p (format - "File %s already exists; make it a link anyway? " + "File %s already exists; make it a link anyway?" localname))))) (tramp-error v 'file-already-exists localname) (delete-file linkname))) diff --git a/lisp/net/tramp.el b/lisp/net/tramp.el index 0182248dfa..6ed67034f4 100644 --- a/lisp/net/tramp.el +++ b/lisp/net/tramp.el @@ -861,7 +861,7 @@ Used in `tramp-make-tramp-file-name'.") (defvar tramp-prefix-regexp nil ;Initialized when defining `tramp-syntax'! "Regexp matching the very beginning of Tramp file names. -Should always start with \"^\". Derived from `tramp-prefix-format'.") +Should always start with \"^\". Derived from `tramp-prefix-format'.") (defconst tramp-method-regexp-alist '((default . "[[:alnum:]-]+") @@ -2379,7 +2379,7 @@ For definition of that list see `tramp-set-completion-function'." ;; Inodes don't exist for some file systems. Therefore we must ;; generate virtual ones. Used in `find-buffer-visiting'. The method -;; applied might be not so efficient (Ange-FTP uses hashes). But +;; applied might be not so efficient (Ange-FTP uses hashes). But ;; performance isn't the major issue given that file transfer will ;; take time. (defvar tramp-inodes 0 @@ -2908,7 +2908,7 @@ not in completion mode." ;; I misuse a little bit the `tramp-file-name' structure in order to ;; handle completion possibilities for partial methods / user names / ;; host names. Return value is a list of `tramp-file-name' structures -;; according to possible completions. If "localname" is non-nil it +;; according to possible completions. If "localname" is non-nil it ;; means there shouldn't be a completion anymore. ;; Expected results: @@ -3288,7 +3288,7 @@ User is always nil." (and (numberp ok-if-already-exists) (not (yes-or-no-p (format - "File %s already exists; make it a link anyway? " + "File %s already exists; make it a link anyway?" localname))))) (tramp-error v 'file-already-exists newname) (delete-file newname))) @@ -3463,7 +3463,7 @@ User is always nil." (or ;; Maybe there is a default value. (tramp-get-method-parameter v 'tramp-case-insensitive) - ;; There isn't. So we must check, in case there's a connection already. + ;; There isn't. So we must check, in case there's a connection already. (and (file-remote-p filename nil 'connected) (with-tramp-connection-property v "case-insensitive" (ignore-errors @@ -3694,7 +3694,7 @@ User is always nil." (yes-or-no-p (concat "Backup file on local temporary directory, " - "do you want to continue? "))))) + "do you want to continue?"))))) (tramp-error v 'file-error "Unsafe backup file name")))))) (defun tramp-handle-insert-directory @@ -3915,7 +3915,7 @@ Return nil when there is no lockfile." (yes-or-no-p (concat "Lock file on local temporary directory, " - "do you want to continue? "))))) + "do you want to continue?"))))) (tramp-error v 'file-error "Unsafe lock file name"))) ;; Do the lock. @@ -4274,13 +4274,13 @@ support symbolic links." ((eq async-shell-command-buffer 'confirm-kill-process) ;; If will kill a process, query first. (if (yes-or-no-p - "A command is running in the default buffer. Kill it? ") + "A command is running in the default buffer. Kill it?") (kill-process p) (tramp-user-error p "Shell command in progress"))) ((eq async-shell-command-buffer 'confirm-new-buffer) ;; If will create a new buffer, query first. (if (yes-or-no-p - "A command is running in the default buffer. Use a new buffer? ") + "A command is running in the default buffer. Use a new buffer?") (setq output-buffer (generate-new-buffer bname)) (tramp-user-error p "Shell command in progress"))) ((eq async-shell-command-buffer 'new-buffer) @@ -4289,7 +4289,7 @@ support symbolic links." ((eq async-shell-command-buffer 'confirm-rename-buffer) ;; If will rename the buffer, query first. (if (yes-or-no-p - "A command is running in the default buffer. Rename it? ") + "A command is running in the default buffer. Rename it?") (progn (with-current-buffer output-buffer (rename-uniquely)) @@ -4492,7 +4492,7 @@ of." (or (eq mustbenew 'excl) (not (y-or-n-p - (format "File %s exists; overwrite anyway? " filename))))) + (format "File %s exists; overwrite anyway?" filename))))) (tramp-error v 'file-already-exists filename)) (let ((file-locked (eq (file-locked-p lockname) t)) @@ -5468,7 +5468,7 @@ this file, if that variable is non-nil." (yes-or-no-p (concat "Autosave file on local temporary directory, " - "do you want to continue? "))))) + "do you want to continue?"))))) (tramp-error v 'file-error "Unsafe autosave file name")))))) (defun tramp-subst-strs-in-string (alist string) diff --git a/lisp/net/trampver.el b/lisp/net/trampver.el index 8ad641ee45..8baf0780c2 100644 --- a/lisp/net/trampver.el +++ b/lisp/net/trampver.el @@ -29,7 +29,7 @@ ;;; Commentary: -;; Convenience functions around the Tramp version. Partly generated +;; Convenience functions around the Tramp version. Partly generated ;; during Tramp configuration. ;;; Code: diff --git a/test/lisp/net/tramp-tests.el b/test/lisp/net/tramp-tests.el index af4f45d691..9f0264abc1 100644 --- a/test/lisp/net/tramp-tests.el +++ b/test/lisp/net/tramp-tests.el @@ -2083,7 +2083,7 @@ Also see `ignore'." "/method:host:/:/path//foo")) ;; Forwhatever reasons, the following tests let Emacs crash for - ;; Emacs 25, occasionally. No idea what's up. + ;; Emacs 25, occasionally. No idea what's up. (when (tramp--test-emacs26-p) (should (string-equal @@ -4464,7 +4464,7 @@ This tests also `make-symbolic-link', `file-truename' and `add-name-to-file'." (should (string-equal (format "%s\n" fnnd) (buffer-string))) (should-not (get-buffer-window (current-buffer) t)) - ;; Second run. The output must be appended. + ;; Second run. The output must be appended. (goto-char (point-max)) (should (zerop (process-file "ls" nil t t fnnd))) ;; `ls' could produce colorized output. @@ -4588,8 +4588,10 @@ This tests also `make-symbolic-link', `file-truename' and `add-name-to-file'." (should (string-match-p (if (memq process-connection-type '(nil pipe)) - "66\n6F\n6F\n0D\n0A\n" - "66\n6F\n6F\n0A\n0A\n") + ;; `telnet' converts \r to if `crlf' + ;; flag is FALSE. See telnet(1) man page. + "66\n6F\n6F\n0D\\(\n00\\)?\n0A\n" + "66\n6F\n6F\n0A\\(\n00\\)?\n0A\n") (buffer-string)))) ;; Cleanup. @@ -4754,8 +4756,9 @@ If UNSTABLE is non-nil, the test is tagged as `:unstable'." ;; Cleanup. (ignore-errors (delete-process proc))) - ;; Process with stderr buffer. - (unless (tramp-direct-async-process-p) + ;; Process with stderr buffer. `telnet' does not cooperate with + ;; three processes. + (unless (or (tramp--test-telnet-p) (tramp-direct-async-process-p)) (let ((stderr (generate-new-buffer "*stderr*"))) (unwind-protect (with-temp-buffer @@ -4851,8 +4854,10 @@ If UNSTABLE is non-nil, the test is tagged as `:unstable'." (string-match-p (if (memq (or connection-type process-connection-type) '(nil pipe)) - "66\n6F\n6F\n0D\n0A\n" - "66\n6F\n6F\n0A\n0A\n") + ;; `telnet' converts \r to if `crlf' + ;; flag is FALSE. See telnet(1) man page. + "66\n6F\n6F\n0D\\(\n00\\)?\n0A\n" + "66\n6F\n6F\n0A\\(\n00\\)?\n0A\n") (buffer-string)))) ;; Cleanup. @@ -5498,9 +5503,9 @@ Use direct async.") ;; Ignore trailing newline. (setq path (substring (shell-command-to-string "echo $PATH") nil -1)) ;; The shell doesn't handle such long strings. - (unless (<= (length path) - (tramp-get-connection-property - tramp-test-vec "pipe-buf" 4096)) + (when (<= (length path) + (tramp-get-connection-property + tramp-test-vec "pipe-buf" 4096)) ;; The last element of `exec-path' is `exec-directory'. (should (string-equal @@ -6154,6 +6159,12 @@ This requires restrictions of file name syntax." "Check, whether the sudoedit method is used." (tramp-sudoedit-file-name-p tramp-test-temporary-file-directory)) +(defun tramp--test-telnet-p () + "Check, whether the telnet method is used. +This does not support special file names." + (string-equal + "telnet" (file-remote-p tramp-test-temporary-file-directory 'method))) + (defun tramp--test-windows-nt-p () "Check, whether the locale host runs MS Windows." (eq system-type 'windows-nt)) @@ -6712,6 +6723,7 @@ process sentinels. They shall not disturb each other." (tramp--test-sh-p))) (skip-unless (not (tramp--test-crypt-p))) (skip-unless (not (tramp--test-docker-p))) + (skip-unless (not (tramp--test-telnet-p))) (skip-unless (not (tramp--test-windows-nt-p))) (with-timeout commit 85c7993631ce49d2082971df8743b2e1ba2fa81d Author: Wilson Snyder Date: Thu Sep 16 10:23:10 2021 -0400 verilog-mode.el: Merge from upstream: prepare for lexical bindings. * verilog-mode.el (verilog-do-indent) (verilog-indent-declaration, verilog-read-always-signals-recurse) (verilog-read-decls): Prepare for lexical bindings. diff --git a/lisp/progmodes/verilog-mode.el b/lisp/progmodes/verilog-mode.el index fe0e4fb083..2b5f85df2f 100644 --- a/lisp/progmodes/verilog-mode.el +++ b/lisp/progmodes/verilog-mode.el @@ -9,7 +9,7 @@ ;; Keywords: languages ;; The "Version" is the date followed by the decimal rendition of the Git ;; commit hex. -;; Version: 2021.09.01.191709444 +;; Version: 2021.09.16.045775504 ;; Yoni Rabkin contacted the maintainer of this ;; file on 19/3/2008, and the maintainer agreed that when a bug is @@ -124,7 +124,7 @@ ;; ;; This variable will always hold the version number of the mode -(defconst verilog-mode-version "2021-09-01-b6d4104-vpo-GNU" +(defconst verilog-mode-version "2021-09-16-2ba7a90-vpo-GNU" "Version of this Verilog mode.") (defconst verilog-mode-release-emacs t "If non-nil, this version of Verilog mode was released with Emacs itself.") @@ -6805,6 +6805,8 @@ Only look at a few lines to determine indent level." (verilog-do-indent (verilog-calculate-indent))) (defun verilog-do-indent (indent-str) + ;; `ind' is used in expressions stored in `verilog-indent-alist'. + (verilog--suppressed-warnings ((lexical ind)) (defvar ind)) (let ((type (car indent-str)) (ind (car (cdr indent-str)))) (cond @@ -7286,6 +7288,8 @@ If QUIET is non-nil, do not print messages showing the progress of line-up." Line up the variable names based on previous declaration's indentation. BASEIND is the base indent to offset everything." (interactive) + ;; `ind' is used in expressions stored in `verilog-indent-alist'. + (verilog--suppressed-warnings ((lexical ind)) (defvar ind)) (let ((pos (point-marker)) (lim (save-excursion ;; (verilog-re-search-backward verilog-declaration-opener nil 'move) @@ -8639,6 +8643,13 @@ Optional NUM-PARAM and MAX-PARAM check for a specific number of parameters." (defun verilog-read-decls () "Compute signal declaration information for the current module at point. Return an array of [outputs inouts inputs wire reg assign const gparam intf]." + (verilog--suppressed-warnings + ((lexical sigs-intf sigs-var sigs-const sigs-assign sigs-var + sigs-gparam sigs-inout sigs-out sigs-in)) + ;; The local variable below are accessed via (symbol-value expect-signal). + (defvar sigs-intf) (defvar sigs-var) (defvar sigs-const) + (defvar sigs-assign) (defvar sigs-var) (defvar sigs-gparam) + (defvar sigs-inout) (defvar sigs-out) (defvar sigs-in)) (let ((end-mod-point (or (verilog-get-end-of-defun) (point-max))) (functask 0) (paren 0) (sig-paren 0) (v2kargs-ok t) in-modport in-clocking in-ign-to-semi ptype ign-prop @@ -9319,6 +9330,9 @@ Must call `verilog-read-auto-lisp-present' before this function." EXIT-KEYWD is expression to stop at, nil if top level. RVALUE is true if at right hand side of equal. TEMP-NEXT is true to ignore next token, fake from inside case statement." + (verilog--suppressed-warnings ((lexical sigs-temp sigs-in sigs-out-unk)) + ;; The local variable below are accessed via (symbol-value got-list). + (defvar sigs-temp) (defvar sigs-in) (defvar sigs-out-unk)) (let* ((semi-rvalue (equal "endcase" exit-keywd)) ; true if after a ; we are looking for rvalue keywd last-keywd sig-tolk sig-last-tolk gotend got-sig got-list end-else-check ignore-next) commit a38675ca884b21e82cfe0c5b43fa168647bdaa6a Author: Eli Zaretskii Date: Thu Sep 16 17:10:49 2021 +0300 Support '...' quoting in Lisp files * lisp/emacs-lisp/lisp-mode.el (lisp-el-font-lock-keywords-2): Support quoting 'like this'. diff --git a/lisp/emacs-lisp/lisp-mode.el b/lisp/emacs-lisp/lisp-mode.el index 42e943a60d..b3b1efc8d2 100644 --- a/lisp/emacs-lisp/lisp-mode.el +++ b/lisp/emacs-lisp/lisp-mode.el @@ -462,8 +462,8 @@ This will generate compile-time constants from BINDINGS." ;; Ineffective backslashes (typically in need of doubling). ("\\(\\\\\\)\\([^\"\\]\\)" (1 (elisp--font-lock-backslash) prepend)) - ;; Words inside ‘’ and `' tend to be symbol names. - (,(concat "[`‘]\\(" lisp-mode-symbol-regexp "\\)['’]") + ;; Words inside ‘’, '' and `' tend to be symbol names. + (,(concat "[`‘']\\(" lisp-mode-symbol-regexp "\\)['’]") (1 font-lock-constant-face prepend)) ;; Constant values. (,(concat "\\_<:" lisp-mode-symbol-regexp "\\_>") commit 2172d6a28dcbc01e7e0773c9ce46d6ad4b47262a Author: Augusto Stoffel Date: Thu Sep 16 16:06:29 2021 +0200 Make 'compile' respect buffer-local process environment * lisp/progmodes/compile.el (compilation-start): Use `process-environment' from original buffer in the compilation process (bug#50607). diff --git a/lisp/progmodes/compile.el b/lisp/progmodes/compile.el index 8d1486b6e6..431b01b8ba 100644 --- a/lisp/progmodes/compile.el +++ b/lisp/progmodes/compile.el @@ -1783,6 +1783,9 @@ Returns the compilation buffer created." (replace-regexp-in-string "-mode\\'" "" (symbol-name mode)))) (thisdir default-directory) (thisenv compilation-environment) + (buffer-path (and (local-variable-p 'exec-path) exec-path)) + (buffer-env (and (local-variable-p 'process-environment) + process-environment)) outwin outbuf) (with-current-buffer (setq outbuf @@ -1850,6 +1853,12 @@ Returns the compilation buffer created." ;; NB: must be done after (funcall mode) as that resets local variables (setq-local compilation-directory thisdir) (setq-local compilation-environment thisenv) + (if buffer-path + (setq-local exec-path buffer-path) + (kill-local-variable 'exec-path)) + (if buffer-env + (setq-local process-environment buffer-env) + (kill-local-variable 'process-environment)) (if highlight-regexp (setq-local compilation-highlight-regexp highlight-regexp)) (if (or compilation-auto-jump-to-first-error commit 7b3007336fedc30a1bce096fcc910a0a36370ee0 Author: Lars Ingebrigtsen Date: Thu Sep 16 16:03:36 2021 +0200 Bind `M-o' in html-mode and enriched-mode * lisp/textmodes/enriched.el (enriched-mode-map): Actually define the `M-o' face map. * lisp/textmodes/sgml-mode.el (html-mode-map): Ditto (bug#50616). * lisp/textmodes/sgml-mode.el (html-mode): Adjust doc string. diff --git a/lisp/textmodes/enriched.el b/lisp/textmodes/enriched.el index c650da43bf..4a5a5ab367 100644 --- a/lisp/textmodes/enriched.el +++ b/lisp/textmodes/enriched.el @@ -191,6 +191,7 @@ The value is a list of \(VAR VALUE VAR VALUE...).") (define-key map "\C-x\t" #'increase-left-margin) (define-key map "\C-c[" #'set-left-margin) (define-key map "\C-c]" #'set-right-margin) + (define-key map "\M-o" #'facemenu-keymap) map) "Keymap for Enriched mode.") diff --git a/lisp/textmodes/sgml-mode.el b/lisp/textmodes/sgml-mode.el index 5bfcc1a20c..7ef8161ab5 100644 --- a/lisp/textmodes/sgml-mode.el +++ b/lisp/textmodes/sgml-mode.el @@ -1835,6 +1835,7 @@ This takes effect when first loading the library.") (define-key map "\C-cs" 'html-span)) (define-key map "\C-c\C-s" 'html-autoview-mode) (define-key map "\C-c\C-v" 'browse-url-of-buffer) + (define-key map "\M-o" 'facemenu-keymap) map) "Keymap for commands for use in HTML mode.") @@ -2372,10 +2373,11 @@ can also view with a browser to see what happens: have

Very Major Headlines

through
Very Minor Headlines
Parts can be separated with horizontal rules. -

Paragraphs only need an opening tag. Line breaks and multiple spaces are -ignored unless the text is 

preformatted.
Text can be marked as -bold, italic or underlined using the normal M-o -or Edit/Text Properties/Face commands. +

Paragraphs only need an opening tag. Line breaks and multiple +spaces are ignored unless the text is 

preformatted.
+Text can be marked as bold, italic or +underlined using the facemenu M-o or Edit/Text +Properties/Face commands. Pages can have named points and can link other points to them with see also somename. In the same way Date: Thu Sep 16 15:48:28 2021 +0200 Allow irc network symbols in erc-autojoin-channels-alist * lisp/erc/erc-join.el (erc-autojoin-channels-alist): Explain the extension. (erc-autojoin-server-match): New function. (erc-autojoin-channels): Use it. (erc-autojoin-current-server): New function. (erc-autojoin-add): Use it. (erc-autojoin-remove): Ditto. This can be useful when connecting to an IRC proxy like Weechat that relays several networks under the same server. If we just keyed on the server name, we would end up joining a channel on all networks whenever we join one network on that server. Networks are simply stored as symbols instead of regexes, since that's how `erc-network' works. The `erc-autojoin-add' function will still auto-add servers as strings if the network doesn't have at least one entry in `erc-autojoin-channels-alist'. diff --git a/lisp/erc/erc-join.el b/lisp/erc/erc-join.el index 2ad9c8bd94..a4986918b6 100644 --- a/lisp/erc/erc-join.el +++ b/lisp/erc/erc-join.el @@ -34,6 +34,7 @@ (require 'erc) (require 'auth-source) +(require 'erc-networks) (defgroup erc-autojoin nil "Enable autojoining." @@ -54,8 +55,12 @@ (defcustom erc-autojoin-channels-alist nil "Alist of channels to autojoin on IRC networks. Every element in the alist has the form (SERVER . CHANNELS). -SERVER is a regexp matching the server, and channels is the -list of channels to join. +SERVER is a regexp matching the server, and channels is the list +of channels to join. SERVER can also be a symbol, in which case +it is matched against the value of `erc-network' instead of +`erc-server-announced-name' or `erc-session-server' (this can be +useful when connecting to an IRC proxy that relays several +networks under the same server). If the channel(s) require channel keys for joining, the passwords are found via auth-source. For instance, if you use ~/.authinfo @@ -117,6 +122,15 @@ This is called from a timer set up by `erc-autojoin-channels'." (erc-log "Delayed autojoin started (no ident success detected yet)") (erc-autojoin-channels server nick)))) +(defun erc-autojoin-server-match (candidate) + "Match the current network or server against CANDIDATE +This should be a key from `erc-autojoin-channels-alist'." + (or (eq candidate (erc-network)) + (and (stringp candidate) + (string-match-p candidate + (or erc-server-announced-name + erc-session-server))))) + (defun erc-autojoin-after-ident (_network _nick) "Autojoin channels in `erc-autojoin-channels-alist'. This function is run from `erc-nickserv-identified-hook'." @@ -131,7 +145,7 @@ This function is run from `erc-nickserv-identified-hook'." ;; We may already be in these channels, e.g. because the ;; autojoin timer went off. (dolist (l erc-autojoin-channels-alist) - (when (string-match (car l) server) + (when (erc-autojoin-server-match (car l)) (dolist (chan (cdr l)) (unless (erc-member-ignore-case chan joined) (erc-server-join-channel server chan))))))) @@ -150,15 +164,14 @@ This function is run from `erc-nickserv-identified-hook'." ;; `erc-autojoin-timing' is `connect': (let ((server (or erc-session-server erc-server-announced-name))) (dolist (l erc-autojoin-channels-alist) - (when (string-match-p (car l) server) + (when (erc-autojoin-server-match (car l)) (dolist (chan (cdr l)) (let ((buffer (car (erc-buffer-filter (lambda () (let ((current (erc-default-target))) (and (stringp current) - (string-match-p (car l) - (or erc-session-server erc-server-announced-name)) + (erc-autojoin-server-match (car l)) (string-equal (erc-downcase chan) (erc-downcase current))))))))) (when (or (not buffer) @@ -168,20 +181,30 @@ This function is run from `erc-nickserv-identified-hook'." ;; Return nil to avoid stomping on any other hook funcs. nil) +(defun erc-autojoin-current-server () + "Compute the current server for lookup in `erc-autojoin-channels-alist'. +Respects `erc-autojoin-domain-only'." + (let ((server (or erc-server-announced-name erc-session-server))) + (if (and erc-autojoin-domain-only + (string-match "[^.\n]+\\.\\([^.\n]+\\.[^.\n]+\\)$" server)) + (match-string 1 server) + server))) + (defun erc-autojoin-add (proc parsed) "Add the channel being joined to `erc-autojoin-channels-alist'." (let* ((chnl (erc-response.contents parsed)) (nick (car (erc-parse-user (erc-response.sender parsed)))) (server (with-current-buffer (process-buffer proc) - (or erc-session-server erc-server-announced-name)))) + (erc-autojoin-current-server)))) (when (erc-current-nick-p nick) - (when (and erc-autojoin-domain-only - (string-match "[^.\n]+\\.\\([^.\n]+\\.[^.\n]+\\)$" server)) - (setq server (match-string 1 server))) - (let ((elem (assoc server erc-autojoin-channels-alist))) + (let ((elem (or (assoc (erc-network) erc-autojoin-channels-alist) + (assoc server erc-autojoin-channels-alist)))) (if elem (unless (member chnl (cdr elem)) (setcdr elem (cons chnl (cdr elem)))) + ;; This always keys on server, not network -- user can + ;; override by simply adding a network to + ;; `erc-autojoin-channels-alist' (setq erc-autojoin-channels-alist (cons (list server chnl) erc-autojoin-channels-alist)))))) @@ -196,12 +219,10 @@ This function is run from `erc-nickserv-identified-hook'." (let* ((chnl (car (erc-response.command-args parsed))) (nick (car (erc-parse-user (erc-response.sender parsed)))) (server (with-current-buffer (process-buffer proc) - (or erc-session-server erc-server-announced-name)))) + (erc-autojoin-current-server)))) (when (erc-current-nick-p nick) - (when (and erc-autojoin-domain-only - (string-match "[^.\n]+\\.\\([^.\n]+\\.[^.\n]+\\)$" server)) - (setq server (match-string 1 server))) - (let ((elem (assoc server erc-autojoin-channels-alist))) + (let ((elem (or (assoc (erc-network) erc-autojoin-channels-alist) + (assoc server erc-autojoin-channels-alist)))) (when elem (setcdr elem (delete chnl (cdr elem))) (unless (cdr elem) commit cfae83adacf0dd5309d20eb383e51a7ae48514b0 Author: Stefan Kangas Date: Thu Sep 16 15:35:10 2021 +0200 ; Normalize some header comments diff --git a/lisp/bs.el b/lisp/bs.el index 494bc42618..ccb06bbdba 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 cd945d8de4..1153961468 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 cb1f6e3c78..d058cfa61c 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 cec573642e..083d8feae4 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 de1cd9d320..6e10b5c4e3 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 6f9ce6a2d6..2192a68791 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 e7aab901d5..7587676ab2 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 2a4b348283..a74ca1ed23 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 178fe944f3..f602c3e13f 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 052a68547b..21ab48b110 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 67ad39b7f4..41384e129b 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 5cc834f4a8..fe0e4fb083 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 b9c3ab57a2..4f8498d9ef 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 1b8654ead2..c5a48f59aa 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 22a29b8b4b..2f7de40da6 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 a3a127474d..7e090177eb 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 d258e6fae2..b72f548f50 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. commit bcf59b99f43be4f40be1ff85d0281d660a8dd731 Author: Stefan Kangas Date: Thu Sep 16 15:33:35 2021 +0200 Prefer "website" to "homepage" These days, a "home page" is understood to be only "the main web page of a website" or "landing page", whereas a "website" is "a collection of web pages and related content" (Wikipedia). * doc/emacs/emacs.texi (Top): * doc/emacs/package.texi (Package Menu): * doc/lispintro/emacs-lisp-intro.texi (Top): * doc/lispref/elisp.texi (Top): * doc/lispref/tips.texi (Documentation Tips): * doc/misc/ede.texi (ede-project): * doc/misc/efaq-w32.texi (More information): * doc/misc/gnus-faq.texi (FAQ 5-7): * doc/misc/gnus.texi (About mairix): * doc/misc/mairix-el.texi (About): * doc/misc/reftex.texi (AUCTeX, Imprint): * lisp/cedet/ede/base.el (ede-project): * lisp/cedet/ede/system.el (ede-web-browse-home): * lisp/emacs-lisp/package.el (package-menu-mode-menu) (package-browse-url): * lisp/erc/erc-button.el (erc-emacswiki-url): * lisp/filesets.el (filesets-goto-homepage): * lisp/net/mairix.el: * lisp/net/webjump.el (webjump-sample-sites): * lisp/obsolete/vc-arch.el: * lisp/progmodes/idlw-shell.el (idlwave-shell-mode): * lisp/progmodes/idlwave.el (idlwave, idlwave-mode): * lisp/textmodes/reftex-vars.el (reftex): Prefer "website" to "home page". * doc/lispref/tips.texi (Documentation Tips): Sort the "URL" header comment before "Homepage". * lisp/emacs-lisp/lisp-mnt.el (lm-website): Rename from 'lm-homepage'. (lm-homepage): Make into alias for 'lm-website'. diff --git a/doc/emacs/emacs.texi b/doc/emacs/emacs.texi index d2011ebf97..2fafb43e9f 100644 --- a/doc/emacs/emacs.texi +++ b/doc/emacs/emacs.texi @@ -116,7 +116,7 @@ ways to customize it; it corresponds to GNU Emacs version @value{EMACSVER}. @c See 'manual-html-mono' and 'manual-html-node' in admin/admin.el. @ifset WWW_GNU_ORG @html -The homepage for GNU Emacs is at +The GNU Emacs website is at https://www.gnu.org/software/emacs/.
To view this manual in other formats, click here.
diff --git a/doc/emacs/package.texi b/doc/emacs/package.texi index d419a4e24b..570afd5be2 100644 --- a/doc/emacs/package.texi +++ b/doc/emacs/package.texi @@ -129,7 +129,7 @@ entails. @item w @kindex w @r{(Package Menu)} @findex package-browse-url -Open the home page of the package on the current line in a browser +Open the package website on the current line in a browser (@code{package-browse-url}). @code{browse-url} is used to open the browser. diff --git a/doc/lispintro/emacs-lisp-intro.texi b/doc/lispintro/emacs-lisp-intro.texi index 7933ebe58c..7c7005b348 100644 --- a/doc/lispintro/emacs-lisp-intro.texi +++ b/doc/lispintro/emacs-lisp-intro.texi @@ -238,7 +238,7 @@ supports it in developing GNU and promoting software freedom.'' @ifset WWW_GNU_ORG @html -

The homepage for GNU Emacs is at +

The GNU Emacs website is at https://www.gnu.org/software/emacs/.
To view this manual in other formats, click here. diff --git a/doc/lispref/elisp.texi b/doc/lispref/elisp.texi index 55bcf399d8..e9e306fa0d 100644 --- a/doc/lispref/elisp.texi +++ b/doc/lispref/elisp.texi @@ -161,7 +161,7 @@ Cover art by Etienne Suvasa. @ifset WWW_GNU_ORG @html -

The homepage for GNU Emacs is at +

The GNU Emacs website is at https://www.gnu.org/software/emacs/.
For information on using Emacs, refer to the Emacs Manual.
diff --git a/doc/lispref/tips.texi b/doc/lispref/tips.texi index 1611b983ea..a72ab88cef 100644 --- a/doc/lispref/tips.texi +++ b/doc/lispref/tips.texi @@ -767,7 +767,7 @@ Finally, to create a hyperlink to URLs, write the single-quoted URL, preceded by @samp{URL}. For example, @smallexample -The home page for the GNU project has more information (see URL +The GNU project wesite has more information (see URL `https://www.gnu.org/'). @end smallexample @@ -1100,9 +1100,9 @@ The name of this field is unfortunate, since people often assume it is the place to write arbitrary keywords that describe their package, rather than just the relevant Finder keywords. -@item Homepage -@itemx URL -These lines state the homepage of the library. +@item URL +@itemx Homepage +These lines state the website of the library. @item Package-Version If @samp{Version} is not suitable for use by the package manager, then diff --git a/doc/misc/ede.texi b/doc/misc/ede.texi index a0f316f848..5e9c3d7eef 100644 --- a/doc/misc/ede.texi +++ b/doc/misc/ede.texi @@ -1556,7 +1556,7 @@ You can also use TRAMP for use with rcp & scp. @item :web-site-file @* -A file which contains the home page for this project. +A file which contains the website for this project. This file can be relative to slot @code{web-site-directory}. This can be a local file, use ange-ftp, EFS, or TRAMP. diff --git a/doc/misc/efaq-w32.texi b/doc/misc/efaq-w32.texi index 6eff88b76e..ba1077d0ac 100644 --- a/doc/misc/efaq-w32.texi +++ b/doc/misc/efaq-w32.texi @@ -2278,7 +2278,7 @@ In Emacs, you can browse the manual using Info by typing @kbd{C-h r}, and you can view the FAQ by typing @kbd{C-h C-f}. Other resources include: @itemize -@item @uref{https://www.gnu.org/software/emacs/, The Emacs homepage} +@item @uref{https://www.gnu.org/software/emacs/, The Emacs website} @item @uref{https://www.gnu.org/software/emacs/manual/, Other Emacs manuals} @item @uref{https://www.emacswiki.org/, Emacs Wiki} @end itemize diff --git a/doc/misc/gnus-faq.texi b/doc/misc/gnus-faq.texi index eac5f0861f..36c402ab35 100644 --- a/doc/misc/gnus-faq.texi +++ b/doc/misc/gnus-faq.texi @@ -1443,7 +1443,7 @@ details. However, what you really want is the Insidious Big Brother Database bbdb. Get it from -@uref{http://bbdb.sourceforge.net/, bbdb's homepage}. +@uref{http://bbdb.sourceforge.net/, bbdb's website}. Now place the following in @file{~/.gnus.el}, to activate bbdb for Gnus: @example diff --git a/doc/misc/gnus.texi b/doc/misc/gnus.texi index 4559ae8e31..5eeffbdeca 100644 --- a/doc/misc/gnus.texi +++ b/doc/misc/gnus.texi @@ -21898,7 +21898,7 @@ bound to mairix searches and are automatically updated. Mairix is a tool for indexing and searching words in locally stored mail. It was written by Richard Curnow and is licensed under the GPL@. Mairix comes with most popular GNU/Linux distributions, but it also -runs under Windows (with cygwin), macOS and Solaris. The homepage can +runs under Windows (with cygwin), macOS and Solaris. The website can be found at @uref{http://www.rpcurnow.force9.co.uk/mairix/index.html} diff --git a/doc/misc/mairix-el.texi b/doc/misc/mairix-el.texi index a571c74487..d0ec552145 100644 --- a/doc/misc/mairix-el.texi +++ b/doc/misc/mairix-el.texi @@ -68,7 +68,7 @@ database. Mairix is a tool for indexing and searching words in locally stored mail. It was written by Richard Curnow and is licensed under the GPL@. Mairix comes with most popular GNU/Linux distributions, but it also -runs under Windows (with cygwin), macOS and Solaris. The homepage can +runs under Windows (with cygwin), macOS and Solaris. The website can be found at @uref{http://www.rpcurnow.force9.co.uk/mairix/index.html} diff --git a/doc/misc/reftex.texi b/doc/misc/reftex.texi index 88ca4450d5..8ca5fcca5b 100644 --- a/doc/misc/reftex.texi +++ b/doc/misc/reftex.texi @@ -3192,7 +3192,7 @@ with the @kbd{g} key. To get this behavior, use instead @AUCTeX{} is without doubt the best major mode for editing @TeX{} and @LaTeX{} files with Emacs (@pxref{Top,AUCTeX,,auctex, The AUCTeX User Manual}). -You can get it from its home page at @value{AUCTEXSITE}, but since +You can get it from its website at @value{AUCTEXSITE}, but since it is available from GNU ELPA, you can simply install it from @kbd{M-x list-packages}. @@ -3565,7 +3565,7 @@ With @i{Viper} mode prior to Vipers version 3.01, you need to protect @cindex Acknowledgments @cindex Thanks @cindex Bug reports -@cindex @code{http}, @RefTeX{} home page +@cindex @code{http}, @RefTeX{} website @cindex @code{ftp}, @RefTeX{} site @c dominik@@science.uva.nl diff --git a/lisp/cedet/ede/base.el b/lisp/cedet/ede/base.el index 103a37045c..004da6b95d 100644 --- a/lisp/cedet/ede/base.el +++ b/lisp/cedet/ede/base.el @@ -212,7 +212,7 @@ You can also use TRAMP for use with rcp & scp.") :label "Web Page File" :group name :documentation - "A file which contains the home page for this project. + "A file which contains the website for this project. This file can be relative to slot `web-site-directory'. This can be a local file, use ange-ftp, EFS, or TRAMP.") (ftp-site :initarg :ftp-site @@ -267,7 +267,7 @@ and target specific elements such as build variables.") '( [ "Update Version" ede-update-version ede-object ] [ "Version Control Status" ede-vc-project-directory ede-object ] - [ "Edit Project Homepage" ede-edit-web-page + [ "Edit Project Website" ede-edit-web-page (and ede-object (oref (ede-toplevel) web-site-file)) ] [ "Browse Project URL" ede-web-browse-home (and ede-object diff --git a/lisp/cedet/ede/system.el b/lisp/cedet/ede/system.el index 8ef38f0d33..1300ba9011 100644 --- a/lisp/cedet/ede/system.el +++ b/lisp/cedet/ede/system.el @@ -34,7 +34,7 @@ ;;;###autoload (defun ede-web-browse-home () - "Browse the home page of the current project." + "Browse the website of the current project." (interactive) (if (not (ede-toplevel)) (error "No project")) diff --git a/lisp/emacs-lisp/lisp-mnt.el b/lisp/emacs-lisp/lisp-mnt.el index df14a5cd49..b27c7e78a8 100644 --- a/lisp/emacs-lisp/lisp-mnt.el +++ b/lisp/emacs-lisp/lisp-mnt.el @@ -498,13 +498,14 @@ absent, return nil." "" (buffer-substring-no-properties start (lm-commentary-end)))))))) -(defun lm-homepage (&optional file) - "Return the homepage in file FILE, or current buffer if FILE is nil." +(defun lm-website (&optional file) + "Return the website in file FILE, or current buffer if FILE is nil." (let ((page (lm-with-file file - (lm-header "\\(?:x-\\)?\\(?:homepage\\|url\\)")))) + (lm-header "\\(?:x-\\)?\\(?:url\\|homepage\\)")))) (if (and page (string-match "^<.+>$" page)) (substring page 1 -1) page))) +(defalias 'lm-homepage 'lm-website) ; for backwards-compatibility ;;; Verification and synopses diff --git a/lisp/emacs-lisp/package.el b/lisp/emacs-lisp/package.el index c6cb8f058b..7418b580e8 100644 --- a/lisp/emacs-lisp/package.el +++ b/lisp/emacs-lisp/package.el @@ -2807,8 +2807,8 @@ either a full name or nil, and EMAIL is a valid email address." "Menu for `package-menu-mode'." '("Package" ["Describe Package" package-menu-describe-package :help "Display information about this package"] - ["Open Package Homepage" package-browse-url - :help "Open the homepage of this package"] + ["Open Package Website" package-browse-url + :help "Open the website of this package"] ["Help" package-menu-quick-help :help "Show short key binding help for package-menu-mode"] "--" ["Refresh Package List" revert-buffer @@ -4230,7 +4230,7 @@ beginning of the line." (package-desc-summary package-desc)))) (defun package-browse-url (desc &optional secondary) - "Open the home page of the package under point in a browser. + "Open the website of the package under point in a browser. `browse-url' is used to determine the browser to be used. If SECONDARY (interactively, the prefix), use the secondary browser." (interactive (list (tabulated-list-get-id) @@ -4240,7 +4240,7 @@ If SECONDARY (interactively, the prefix), use the secondary browser." (user-error "No package here")) (let ((url (cdr (assoc :url (package-desc-extras desc))))) (unless url - (user-error "No home page for %s" (package-desc-name desc))) + (user-error "No website for %s" (package-desc-name desc))) (if secondary (funcall browse-url-secondary-browser-function url) (browse-url url)))) diff --git a/lisp/erc/erc-button.el b/lisp/erc/erc-button.el index 5953471ae8..fc72f324eb 100644 --- a/lisp/erc/erc-button.el +++ b/lisp/erc/erc-button.el @@ -195,7 +195,7 @@ PAR is a number of a regexp grouping whose text will be passed to (integer :tag "Regexp section number"))))) (defcustom erc-emacswiki-url "https://www.emacswiki.org/cgi-bin/wiki.pl?" - "URL of the EmacsWiki Homepage." + "URL of the EmacsWiki website." :type 'string) (defcustom erc-emacswiki-lisp-url "https://www.emacswiki.org/elisp/" diff --git a/lisp/filesets.el b/lisp/filesets.el index 8e9fae80f6..d138675066 100644 --- a/lisp/filesets.el +++ b/lisp/filesets.el @@ -1848,7 +1848,7 @@ User will be queried, if no fileset name is provided." (filesets-goto-homepage))) (defun filesets-goto-homepage () - "Show filesets's homepage." + "Show filesets's website." (interactive) (browse-url filesets-homepage)) diff --git a/lisp/net/mairix.el b/lisp/net/mairix.el index 727aa55de5..3feb089ad0 100644 --- a/lisp/net/mairix.el +++ b/lisp/net/mairix.el @@ -24,7 +24,7 @@ ;; This is an interface to the mairix mail search engine. Mairix is ;; written by Richard Curnow and is licensed under the GPL. See the -;; home page for details: +;; Mairix website for details: ;; ;; http://www.rpcurnow.force9.co.uk/mairix/ ;; diff --git a/lisp/net/webjump.el b/lisp/net/webjump.el index 4baa657c0a..d14d382aac 100644 --- a/lisp/net/webjump.el +++ b/lisp/net/webjump.el @@ -79,10 +79,10 @@ ;; GNU FTP Mirror List from https://www.gnu.org/order/ftp.html [mirrors "https://ftp.gnu.org/pub/gnu/" "https://ftpmirror.gnu.org"]) - ("GNU Project Home Page" . "www.gnu.org") + ("GNU Project Website" . "www.gnu.org") ;; Emacs. - ("Emacs Home Page" . + ("Emacs Website" . "www.gnu.org/software/emacs/emacs.html") ("Savannah Emacs page" . "savannah.gnu.org/projects/emacs") diff --git a/lisp/obsolete/vc-arch.el b/lisp/obsolete/vc-arch.el index cfbf981d3c..fbbd2d4ecf 100644 --- a/lisp/obsolete/vc-arch.el +++ b/lisp/obsolete/vc-arch.el @@ -24,7 +24,7 @@ ;;; Commentary: -;; The home page of the Arch version control system is at +;; The Arch version control system website is at ;; ;; https://www.gnu.org/software/gnu-arch/ ;; diff --git a/lisp/progmodes/idlw-shell.el b/lisp/progmodes/idlw-shell.el index eb88f25dfd..f2bfbf3e37 100644 --- a/lisp/progmodes/idlw-shell.el +++ b/lisp/progmodes/idlw-shell.el @@ -878,8 +878,8 @@ IDL has currently stepped.") ------------------------------- Info documentation for this package is available. Use \\[idlwave-info] to display (complain to your sysadmin if that does not work). - For PostScript and HTML versions of the documentation, check IDLWAVE's - homepage at URL `https://github.com/jdtsmith/idlwave'. + For PostScript and HTML versions of the documentation, see IDLWAVE's + website at URL `https://github.com/jdtsmith/idlwave'. IDLWAVE has customize support - see the group `idlwave'. 8. Keybindings diff --git a/lisp/progmodes/idlwave.el b/lisp/progmodes/idlwave.el index 55e712dd77..91be401623 100644 --- a/lisp/progmodes/idlwave.el +++ b/lisp/progmodes/idlwave.el @@ -163,7 +163,7 @@ (defgroup idlwave nil "Major mode for editing IDL .pro files." :tag "IDLWAVE" - :link '(url-link :tag "Home Page" + :link '(url-link :tag "Website" "https://github.com/jdtsmith/idlwave") :link '(emacs-commentary-link :tag "Commentary in idlw-shell.el" "idlw-shell.el") @@ -1821,7 +1821,7 @@ The main features of this mode are Info documentation for this package is available. Use \\[idlwave-info] to display (complain to your sysadmin if that does not work). For Postscript, PDF, and HTML versions of the - documentation, check IDLWAVE's homepage at URL + documentation, check IDLWAVE's website at URL `https://github.com/jdtsmith/idlwave'. IDLWAVE has customize support - see the group `idlwave'. diff --git a/lisp/textmodes/reftex-vars.el b/lisp/textmodes/reftex-vars.el index cfdf256f70..19b40e6ce2 100644 --- a/lisp/textmodes/reftex-vars.el +++ b/lisp/textmodes/reftex-vars.el @@ -263,7 +263,7 @@ distribution. Mixed-case symbols are convenience aliases.") (defgroup reftex nil "LaTeX label and citation support." :tag "RefTeX" - :link '(url-link :tag "Home Page" + :link '(url-link :tag "Website" "https://www.gnu.org/software/auctex/reftex.html") :link '(emacs-commentary-link :tag "Commentary in reftex.el" "reftex.el") :link '(custom-manual "(reftex)Top") commit 426c5fdfb240f101c3f3ee6e001684c1f82c790f Author: F. Jason Park Date: Thu Sep 16 15:35:55 2021 +0200 Change the erc debug logging format to be more repeatable * erc.el (erc-debug-irc-protocol): Fix line-ending mismatch between incoming and outgoing logger lines without changing interface. Do this by adding carriage returns to the latter to improve machine readability. Change printed peer labels to most accurately reflect logical endpoints. (erc-debug-irc-protocol-time-format): Add new variable to support timestamps in protocol logger output. (erc-debug-irc-protocol-version): Add new variable to help tooling track logging format independent of ERC and Emacs versions. (erc-toggle-debug-irc-protocol): Add headers to protocol-log buffer to aid future bug-reproduction tools. Clean up overlong lines (bug#50009). diff --git a/lisp/erc/erc.el b/lisp/erc/erc.el index a2e9e84eef..60168d42f9 100644 --- a/lisp/erc/erc.el +++ b/lisp/erc/erc.el @@ -2303,6 +2303,22 @@ message instead, to make debugging easier." ;;; Debugging the protocol +(defvar erc-debug-irc-protocol-time-format "%FT%T.%6N%z " + "Timestamp format string for protocol logger.") + +(defconst erc-debug-irc-protocol-version "1" + "Protocol log format version number. +This exists to help tooling track changes to the format. + +In version 1, everything before and including the first double CRLF is +front matter, which must also be CRLF terminated. Lines beginning with +three asterisks must be ignored as comments. Other lines should be +interpreted as email-style headers. Folding is not supported. A second +double CRLF, if present, signals the end of a log. Session resumption +is not supported. Logger lines must adhere to the following format: +TIMESTAMP PEER-NAME FLOW-INDICATOR IRC-MESSAGE CRLF. Outgoing messages +are indicated with a >> and incoming with a <<.") + (defvar erc-debug-irc-protocol nil "If non-nil, log all IRC protocol traffic to the buffer \"*erc-protocol*\". @@ -2324,32 +2340,32 @@ This only has any effect if `erc-debug-irc-protocol' is non-nil. The buffer is created if it doesn't exist. -If OUTBOUND is non-nil, STRING is being sent to the IRC server -and appears in face `erc-input-face' in the buffer." +If OUTBOUND is non-nil, STRING is being sent to the IRC server and +appears in face `erc-input-face' in the buffer. Lines must already +contain CRLF endings. Peer is identified by the most precise label +available at run time, starting with the network name, followed by the +announced host name, and falling back to the dialed :." (when erc-debug-irc-protocol - (let ((network-name (or (ignore-errors (erc-network-name)) - "???"))) + (let ((esid (or (and (fboundp 'erc-network) + (erc-network) + (erc-network-name)) + erc-server-announced-name + (format "%s:%s" erc-session-server erc-session-port))) + (ts (when erc-debug-irc-protocol-time-format + (format-time-string erc-debug-irc-protocol-time-format)))) (with-current-buffer (get-buffer-create "*erc-protocol*") (save-excursion (goto-char (point-max)) (let ((inhibit-read-only t)) - (insert (if (not outbound) - ;; Cope with the fact that string might - ;; contain multiple lines of text. - (let ((lines (delete "" (split-string string - "\n\\|\r\n"))) - (result "")) - (dolist (line lines) - (setq result (concat result network-name - " << " line "\n"))) - result) - (propertize - (concat network-name " >> " string - (if (/= ?\n - (aref string - (1- (length string)))) - "\n")) - 'font-lock-face 'erc-input-face))))) + (insert (if outbound + (concat ts esid " >> " string) + ;; Cope with multi-line messages + (let ((lines (split-string string "[\r\n]+" t)) + result) + (dolist (line lines) + (setq result (concat result ts esid + " << " line "\r\n"))) + result))))) (let ((orig-win (selected-window)) (debug-buffer-window (get-buffer-window (current-buffer) t))) (when debug-buffer-window @@ -2368,9 +2384,16 @@ If ARG is non-nil, show the *erc-protocol* buffer." (with-current-buffer buf (view-mode-enter) (when (null (current-local-map)) - (let ((inhibit-read-only t)) - (insert (erc-make-notice "This buffer displays all IRC protocol traffic exchanged with each server.\n")) - (insert (erc-make-notice "Kill this buffer to terminate protocol logging.\n\n"))) + (let ((inhibit-read-only t) + (msg (list + (concat "Version: " erc-debug-irc-protocol-version) + (concat "Emacs-Version: " emacs-version) + (erc-make-notice + (concat "This buffer displays all IRC protocol " + "traffic exchanged with servers.")) + (erc-make-notice "Kill it to disable logging.") + (erc-make-notice "Press `t' to toggle.")))) + (insert (string-join msg "\r\n"))) (use-local-map (make-sparse-keymap)) (local-set-key (kbd "t") 'erc-toggle-debug-irc-protocol)) (add-hook 'kill-buffer-hook @@ -2378,10 +2401,12 @@ If ARG is non-nil, show the *erc-protocol* buffer." nil 'local) (goto-char (point-max)) (let ((inhibit-read-only t)) - (insert (erc-make-notice - (format "IRC protocol logging %s at %s -- Press `t' to toggle logging.\n" + (insert (if erc-debug-irc-protocol "\r\n" "") + (erc-make-notice + (format "IRC protocol logging %s at %s" (if erc-debug-irc-protocol "disabled" "enabled") - (current-time-string)))))) + (current-time-string))) + (if erc-debug-irc-protocol "\r\n" "\r\n\r\n")))) (setq erc-debug-irc-protocol (not erc-debug-irc-protocol)) (if (and arg (not (get-buffer-window "*erc-protocol*" t))) diff --git a/test/lisp/erc/erc-tests.el b/test/lisp/erc/erc-tests.el index 0533d04491..22f62a35c7 100644 --- a/test/lisp/erc/erc-tests.el +++ b/test/lisp/erc/erc-tests.el @@ -192,3 +192,38 @@ (should (looking-at "abc"))))) (when noninteractive (kill-buffer "*#fake*"))) + +(ert-deftest erc-log-irc-protocol () + (should-not erc-debug-irc-protocol) + (with-temp-buffer + (setq erc-server-process (start-process "fake" (current-buffer) "true") + erc-server-current-nick "tester" + erc-session-server "myproxy.localhost" + erc-session-port 6667) + (let ((inhibit-message noninteractive)) + (erc-toggle-debug-irc-protocol) + (erc-log-irc-protocol "PASS changeme\r\n" 'outgoing) + (setq erc-server-announced-name "irc.gnu.org") + (erc-log-irc-protocol ":irc.gnu.org 001 tester :Welcome") + (erc-log-irc-protocol ":irc.gnu.org 002 tester :Your host is irc.gnu.org") + (setq erc-network 'FooNet) + (erc-log-irc-protocol ":irc.gnu.org 422 tester :MOTD missing") + (setq erc-network 'BarNet) + (erc-log-irc-protocol ":irc.gnu.org 221 tester +i") + (set-process-query-on-exit-flag erc-server-process nil))) + (with-current-buffer "*erc-protocol*" + (goto-char (point-min)) + (search-forward "Version") + (search-forward "\r\n\r\n") + (search-forward "myproxy.localhost:6667 >> PASS" (line-end-position)) + (forward-line) + (search-forward "irc.gnu.org << :irc.gnu.org 001" (line-end-position)) + (forward-line) + (search-forward "irc.gnu.org << :irc.gnu.org 002" (line-end-position)) + (forward-line) + (search-forward "FooNet << :irc.gnu.org 422" (line-end-position)) + (forward-line) + (search-forward "BarNet << :irc.gnu.org 221" (line-end-position))) + (when noninteractive + (kill-buffer "*erc-protocol*") + (should-not erc-debug-irc-protocol))) commit fb2971e18e2d945574a1ff53cae39b861e974989 Author: F. Jason Park Date: Thu Sep 16 15:25:18 2021 +0200 Fix erc nick trimming * lisp/erc/erc.el (erc-lurker-maybe-trim): Prevent warning from showing up in third-party code using this function by autoloading rx.el when needed. Remove trailing chars appended for uniquifying purposes when a nick is already taken. Special thanks to Mattias EngdegÄrd for making this more respectable (Bug#50005). * test/lisp/erc/erc-tests.el: Add tests for the above and require erc-networks. diff --git a/lisp/erc/erc.el b/lisp/erc/erc.el index f01a99a30a..a2e9e84eef 100644 --- a/lisp/erc/erc.el +++ b/lisp/erc/erc.el @@ -1732,20 +1732,11 @@ FORMS will be evaluated in all buffers having the process PROCESS and where PRED matches or in all buffers of the server process if PRED is nil." (declare (indent 1) (debug (form form body))) - ;; Make the evaluation have the correct order - (let ((pre (make-symbol "pre")) - (pro (make-symbol "pro"))) - `(let* ((,pro ,process) - (,pre ,pred) - (res (mapcar (lambda (buffer) - (with-current-buffer buffer - ,@forms)) - (erc-buffer-list ,pre - ,pro)))) - ;; Silence the byte-compiler by binding the result of mapcar to - ;; a variable. - (ignore res) - res))) + (macroexp-let2 nil pred pred + `(erc-buffer-filter (lambda () + (when (or (not ,pred) (funcall ,pred)) + ,@forms)) + ,process))) (define-obsolete-function-alias 'erc-iswitchb #'erc-switch-to-buffer "25.1") (defun erc--switch-to-buffer (&optional arg) @@ -2583,9 +2574,8 @@ See also `erc-lurker-trim-nicks'." Returns NICK unmodified unless `erc-lurker-trim-nicks' is non-nil." (if erc-lurker-trim-nicks - (replace-regexp-in-string - (regexp-opt-charset (string-to-list erc-lurker-ignore-chars)) - "" nick) + (string-trim-right + nick (rx-to-string `(+ (in ,@(string-to-list erc-lurker-ignore-chars))))) nick)) (defcustom erc-lurker-hide-list nil diff --git a/test/lisp/erc/erc-tests.el b/test/lisp/erc/erc-tests.el index 9efcf4a703..0533d04491 100644 --- a/test/lisp/erc/erc-tests.el +++ b/test/lisp/erc/erc-tests.el @@ -24,6 +24,7 @@ (require 'ert) (require 'erc) (require 'erc-ring) +(require 'erc-networks) (ert-deftest erc--read-time-period () (cl-letf (((symbol-function 'read-string) (lambda (&rest _) ""))) @@ -47,6 +48,85 @@ (cl-letf (((symbol-function 'read-string) (lambda (&rest _) "1d"))) (should (equal (erc--read-time-period "foo: ") 86400)))) +(ert-deftest erc-with-all-buffers-of-server () + (let (proc-exnet + proc-onet + erc-kill-channel-hook erc-kill-server-hook erc-kill-buffer-hook) + + (with-current-buffer (get-buffer-create "OtherNet") + (erc-mode) + (setq proc-onet (start-process "sleep" (current-buffer) "sleep" "1") + erc-server-process proc-onet + erc-network 'OtherNet) + (set-process-query-on-exit-flag erc-server-process nil)) + + (with-current-buffer (get-buffer-create "ExampleNet") + (erc-mode) + (setq proc-exnet (start-process "sleep" (current-buffer) "sleep" "1") + erc-server-process proc-exnet + erc-network 'ExampleNet) + (set-process-query-on-exit-flag erc-server-process nil)) + + (with-current-buffer (get-buffer-create "#foo") + (erc-mode) + (setq erc-server-process proc-exnet) + (setq erc-default-recipients '("#foo"))) + + (with-current-buffer (get-buffer-create "#spam") + (erc-mode) + (setq erc-server-process proc-onet) + (setq erc-default-recipients '("#spam"))) + + (with-current-buffer (get-buffer-create "#bar") + (erc-mode) + (setq erc-server-process proc-onet) + (setq erc-default-recipients '("#bar"))) + + (with-current-buffer (get-buffer-create "#baz") + (erc-mode) + (setq erc-server-process proc-exnet) + (setq erc-default-recipients '("#baz"))) + + (should (eq (get-buffer-process "ExampleNet") proc-exnet)) + (erc-with-all-buffers-of-server (get-buffer-process "ExampleNet") + nil + (kill-buffer)) + + (should-not (get-buffer "ExampleNet")) + (should-not (get-buffer "#foo")) + (should-not (get-buffer "#baz")) + (should (get-buffer "OtherNet")) + (should (get-buffer "#bar")) + (should (get-buffer "#spam")) + + (let* ((test (lambda () (not (string= (buffer-name) "#spam")))) + (calls 0) + (get-test (lambda () (cl-incf calls) test))) + + (erc-with-all-buffers-of-server proc-onet + (funcall get-test) + (kill-buffer)) + + (should (= calls 1))) + + (should-not (get-buffer "OtherNet")) + (should-not (get-buffer "#bar")) + (should (get-buffer "#spam")) + (kill-buffer "#spam"))) + +(ert-deftest erc-lurker-maybe-trim () + (let (erc-lurker-trim-nicks + (erc-lurker-ignore-chars "_`")) + + (should (string= "nick`" (erc-lurker-maybe-trim "nick`"))) + + (setq erc-lurker-trim-nicks t) + (should (string= "nick" (erc-lurker-maybe-trim "nick`"))) + (should (string= "ni`_ck" (erc-lurker-maybe-trim "ni`_ck__``"))) + + (setq erc-lurker-ignore-chars "_-`") ; set of chars, not character alts + (should (string= "nick" (erc-lurker-maybe-trim "nick-_`"))))) + (ert-deftest erc-ring-previous-command-base-case () (ert-info ("Create ring when nonexistent and do nothing") (let (erc-input-ring commit 492fd05ac21f10efc82a93eed23bdd4532bbb0b1 Author: F. Jason Park Date: Thu Sep 16 15:20:59 2021 +0200 Fix mistake in test for erc-ring-previous-command * test/lisp/erc/erc-tests.el (erc-ring-previous-command): The variable erc-send-completed-hook was previously set to nil permanently, which would affect other tests (bug#50005). diff --git a/test/lisp/erc/erc-tests.el b/test/lisp/erc/erc-tests.el index d13397274a..9efcf4a703 100644 --- a/test/lisp/erc/erc-tests.el +++ b/test/lisp/erc/erc-tests.el @@ -61,13 +61,16 @@ (with-current-buffer (get-buffer-create "*#fake*") (erc-mode) (insert "\n\n") - (setq erc-input-marker (make-marker) ; these are all local - erc-insert-marker (make-marker) - erc-send-completed-hook nil) + (should-not (local-variable-if-set-p 'erc-send-completed-hook)) + (set (make-local-variable 'erc-send-completed-hook) nil) ; skip t (globals) + (setq erc-input-marker (make-marker) + erc-insert-marker (make-marker)) (set-marker erc-insert-marker (point-max)) (erc-display-prompt) (should (= (point) erc-input-marker)) - (add-hook 'erc-pre-send-functions #'erc-add-to-input-ring nil t) + ;; Just in case erc-ring-mode is already on + (setq-local erc-pre-send-functions nil) + (add-hook 'erc-pre-send-functions #'erc-add-to-input-ring) ;; (cl-letf (((symbol-function 'erc-process-input-line) (lambda (&rest _) commit f3762d59d92c832f8417e8eeadc49c19d1c367bb Author: Stefan Kangas Date: Thu Sep 16 14:47:51 2021 +0200 Do interactive mode tagging for play/*.el diff --git a/lisp/play/doctor.el b/lisp/play/doctor.el index bf923f4f2e..9777fc3ea2 100644 --- a/lisp/play/doctor.el +++ b/lisp/play/doctor.el @@ -137,6 +137,7 @@ Like Text mode with Auto Fill mode except that RET when point is after a newline, or LFD at any time, reads the sentence before point, and prints the Doctor's answer." + :interactive nil (make-doctor-variables) (turn-on-auto-fill) (doctor-type '(i am the psychotherapist \. @@ -827,14 +828,14 @@ reads the sentence before point, and prints the Doctor's answer." (defun doctor-ret-or-read (arg) "Insert a newline if preceding character is not a newline. Otherwise call the Doctor to parse preceding sentence." - (interactive "*p") + (interactive "*p" doctor-mode) (if (= (preceding-char) ?\n) (doctor-read-print) (newline arg))) (defun doctor-read-print () "Top level loop." - (interactive) + (interactive nil doctor-mode) (setq doctor-sent (doctor-readin)) (insert "\n") (setq doctor--lincount (1+ doctor--lincount)) diff --git a/lisp/play/dunnet.el b/lisp/play/dunnet.el index 9d5ee26197..332e743ed8 100644 --- a/lisp/play/dunnet.el +++ b/lisp/play/dunnet.el @@ -1135,11 +1135,12 @@ treasures for points?" "4" "four") (define-derived-mode dun-mode text-mode "Dungeon" "Major mode for running dunnet." + :interactive nil (setq-local scroll-step 2)) (defun dun-parse (_arg) "Function called when return is pressed in interactive mode to parse line." - (interactive "*p") + (interactive "*p" dun-mode) (beginning-of-line) (let ((beg (1+ (point))) line) @@ -2229,7 +2230,7 @@ Call the proper verb with the rest of the line passed in as a list." (defun dun-fix-screen () "In window mode, keep screen from jumping by keeping last line at the bottom of the screen." - (interactive) + (interactive nil dun-mode) (forward-line (- 0 (- (window-height) 2 ))) (set-window-start (selected-window) (point)) (goto-char (point-max))) @@ -2336,7 +2337,7 @@ Also prints current score to let user know he has scored." ;;;; (defun dun-unix-parse (_args) - (interactive "*p") + (interactive "*p" dun-mode) (beginning-of-line) (let (beg esign) (setq beg (+ (point) 2)) @@ -2825,7 +2826,7 @@ drwxr-xr-x 3 root staff 2048 Jan 1 1970 ..") ;;;; (defun dun-dos-parse (_args) - (interactive "*p") + (interactive "*p" dun-mode) (beginning-of-line) (let (beg) (setq beg (+ (point) 3)) @@ -3119,7 +3120,7 @@ File not found"))) (defun dungeon-nil (_arg) "noop" - (interactive "*p") + (interactive "*p" dun-mode) nil) (defun dun-batch-dungeon () diff --git a/lisp/play/mpuz.el b/lisp/play/mpuz.el index 838bddfb66..123cc3cfac 100644 --- a/lisp/play/mpuz.el +++ b/lisp/play/mpuz.el @@ -89,6 +89,7 @@ The value t means never ding, and `error' means only ding on wrong input." (define-derived-mode mpuz-mode fundamental-mode "Mult Puzzle" + :interactive nil "Multiplication puzzle mode. You have to guess which letters stand for which digits in the @@ -367,7 +368,7 @@ You may abort a game by typing \\\\[mpuz-offer-abort]." (defun mpuz-offer-abort () "Ask if user wants to abort current puzzle." - (interactive) + (interactive nil mpuz-mode) (if (y-or-n-p "Abort game? ") (let ((buf (mpuz-get-buffer))) (message "Mult Puzzle aborted.") @@ -389,7 +390,7 @@ You may abort a game by typing \\\\[mpuz-offer-abort]." (defun mpuz-try-letter () "Propose a digit for a letter in puzzle." - (interactive) + (interactive nil mpuz-mode) (if mpuz-in-progress (let (letter-char digit digit-char) (setq letter-char (upcase last-command-event) @@ -474,7 +475,7 @@ You may abort a game by typing \\\\[mpuz-offer-abort]." (defun mpuz-show-solution (row) "Display solution for debugging purposes." - (interactive "P") + (interactive "P" mpuz-mode) (mpuz-switch-to-window) (mpuz-solve (if row (* 2 (prefix-numeric-value row)))) (mpuz-paint-board) diff --git a/lisp/play/pong.el b/lisp/play/pong.el index b73dbc1010..b8545dfa82 100644 --- a/lisp/play/pong.el +++ b/lisp/play/pong.el @@ -216,7 +216,6 @@ (defun pong-init-buffer () "Initialize pong buffer and draw stuff thanks to gamegrid library." - (interactive) (get-buffer-create pong-buffer-name) (switch-to-buffer pong-buffer-name) (use-local-map pong-mode-map) @@ -249,7 +248,7 @@ "Move bat 1 up. This is called left for historical reasons, since in some pong implementations you move with left/right paddle." - (interactive) + (interactive nil pong-mode) (if (> pong-bat-player1 1) (and (setq pong-bat-player1 (1- pong-bat-player1)) @@ -259,7 +258,7 @@ implementations you move with left/right paddle." (defun pong-move-right () "Move bat 1 down." - (interactive) + (interactive nil pong-mode) (if (< (+ pong-bat-player1 pong-bat-width) (1- pong-height)) (and (setq pong-bat-player1 (1+ pong-bat-player1)) @@ -269,7 +268,7 @@ implementations you move with left/right paddle." (defun pong-move-up () "Move bat 2 up." - (interactive) + (interactive nil pong-mode) (if (> pong-bat-player2 1) (and (setq pong-bat-player2 (1- pong-bat-player2)) @@ -279,7 +278,7 @@ implementations you move with left/right paddle." (defun pong-move-down () "Move bat 2 down." - (interactive) + (interactive nil pong-mode) (if (< (+ pong-bat-player2 pong-bat-width) (1- pong-height)) (and (setq pong-bat-player2 (1+ pong-bat-player2)) @@ -412,7 +411,7 @@ detection and checks if a player scores." (defun pong-pause () "Pause the game." - (interactive) + (interactive nil pong-mode) (gamegrid-kill-timer) ;; Oooohhh ugly. I don't know why, gamegrid-kill-timer don't do the ;; jobs it is made for. So I have to do it "by hand". Anyway, next @@ -424,7 +423,7 @@ detection and checks if a player scores." (defun pong-resume () "Resume a paused game." - (interactive) + (interactive nil pong-mode) (define-key pong-mode-map pong-pause-key 'pong-pause) (gamegrid-start-timer pong-timer-delay 'pong-update-game)) @@ -432,7 +431,7 @@ detection and checks if a player scores." (defun pong-quit () "Quit the game and kill the pong buffer." - (interactive) + (interactive nil pong-mode) (gamegrid-kill-timer) ;; Be sure not to draw things in another buffer and wait for some ;; time. diff --git a/lisp/play/solitaire.el b/lisp/play/solitaire.el index e74ba98ca1..bc1a0e44cb 100644 --- a/lisp/play/solitaire.el +++ b/lisp/play/solitaire.el @@ -93,6 +93,7 @@ To learn how to play Solitaire, see the documentation for function \\ The usual mnemonic keys move the cursor around the board; in addition, \\[solitaire-move] is a prefix character for actually moving a stone on the board." + :interactive nil (setq truncate-lines t) (setq show-trailing-whitespace nil)) @@ -248,7 +249,7 @@ Pick your favorite shortcuts: (setq solitaire-end-y (solitaire-current-line)))) (defun solitaire-right () - (interactive) + (interactive nil solitaire-mode) (let ((start (point))) (forward-char) (while (= ?\s (following-char)) @@ -259,7 +260,7 @@ Pick your favorite shortcuts: (goto-char start)))) (defun solitaire-left () - (interactive) + (interactive nil solitaire-mode) (let ((start (point))) (backward-char) (while (= ?\s (following-char)) @@ -270,7 +271,7 @@ Pick your favorite shortcuts: (goto-char start)))) (defun solitaire-up () - (interactive) + (interactive nil solitaire-mode) (let ((start (point)) (c (current-column))) (forward-line -1) @@ -286,7 +287,7 @@ Pick your favorite shortcuts: (goto-char start)))) (defun solitaire-down () - (interactive) + (interactive nil solitaire-mode) (let ((start (point)) (c (current-column))) (forward-line 1) @@ -301,13 +302,13 @@ Pick your favorite shortcuts: (goto-char start)))) (defun solitaire-center-point () - (interactive) + (interactive nil solitaire-mode) (goto-char solitaire-center)) -(defun solitaire-move-right () (interactive) (solitaire-move '[right])) -(defun solitaire-move-left () (interactive) (solitaire-move '[left])) -(defun solitaire-move-up () (interactive) (solitaire-move '[up])) -(defun solitaire-move-down () (interactive) (solitaire-move '[down])) +(defun solitaire-move-right () (interactive nil solitaire-mode) (solitaire-move '[right])) +(defun solitaire-move-left () (interactive nil solitaire-mode) (solitaire-move '[left])) +(defun solitaire-move-up () (interactive nil solitaire-mode) (solitaire-move '[up])) +(defun solitaire-move-down () (interactive nil solitaire-mode) (solitaire-move '[down])) (defun solitaire-possible-move (movesymbol) "Check if a move is possible from current point in the specified direction. @@ -332,7 +333,7 @@ which a stone will be taken away) and target." (defun solitaire-move (dir) "Pseudo-prefix command to move a stone in Solitaire." - (interactive "kMove where? ") + (interactive "kMove where? " solitaire-mode) (let* ((class (solitaire-possible-move (lookup-key solitaire-mode-map dir))) (buffer-read-only nil)) (if (stringp class) @@ -356,7 +357,7 @@ which a stone will be taken away) and target." (defun solitaire-undo (arg) "Undo a move in Solitaire." - (interactive "P") + (interactive "P" solitaire-mode) (let ((buffer-read-only nil)) (undo arg)) (save-excursion @@ -393,7 +394,7 @@ which a stone will be taken away) and target." (defun solitaire-do-check (&optional _arg) "Check for any possible moves in Solitaire." - (interactive "P") + (interactive "P" solitaire-mode) (let ((moves (solitaire-check))) (cond ((= 1 solitaire-stones) (message "Yeah! You made it! Only the King is left!")) @@ -414,7 +415,7 @@ Seen in info on text lines." (defun solitaire-solve () "Spoil Solitaire by solving the game for you - nearly ... ... stops with five stones left ;)" - (interactive) + (interactive nil solitaire-mode) (when (< solitaire-stones 32) (error "Cannot solve game in progress")) (let ((allmoves [up up S-down up left left S-right up up left S-down commit 208c49206950910b21d77f777241e0869c3a4bd9 Author: Eli Zaretskii Date: Thu Sep 16 15:37:22 2021 +0300 ; * src/minibuf.c (Ftest_completion): Clarify doc string. diff --git a/src/minibuf.c b/src/minibuf.c index a0ba86763f..0e7baf30dc 100644 --- a/src/minibuf.c +++ b/src/minibuf.c @@ -2055,8 +2055,8 @@ See also `completing-read-function'. */) /* Test whether TXT is an exact completion. */ DEFUN ("test-completion", Ftest_completion, Stest_completion, 2, 3, 0, doc: /* Return non-nil if STRING is a valid completion. -For instance, if COLLECTION is a list of strings, this is true if -STRING appears in the list and PREDICATE is satisfied. +For instance, if COLLECTION is a list of strings, STRING is a +valid completion if it appears in the list and PREDICATE is satisfied. Takes the same arguments as `all-completions' and `try-completion'. commit a9558baaf99ec3878f82a1e1e6225e828c9de532 Author: Eli Zaretskii Date: Thu Sep 16 15:34:36 2021 +0300 Clarify use of early-init file * doc/emacs/custom.texi (Early Init File): Clarify that using the early-init file should be reserved to cases where it is absolutely necessary. (Bug#50491) diff --git a/doc/emacs/custom.texi b/doc/emacs/custom.texi index 9220a2078f..d12033f841 100644 --- a/doc/emacs/custom.texi +++ b/doc/emacs/custom.texi @@ -2807,12 +2807,12 @@ Type @kbd{C-q}, followed by the key you want to bind, to insert @var{char}. @cindex early init file Most customizations for Emacs should be put in the normal init file. -@xref{Init File}. However, it is sometimes desirable -to have customizations that take effect during Emacs startup earlier than the +@xref{Init File}. However, it is sometimes necessary +to have customizations take effect during Emacs startup earlier than the normal init file is processed. Such customizations can be put in the early init file, @file{~/.config/emacs/early-init.el} or @file{~/.emacs.d/early-init.el}. This file is loaded before the package system and GUI is initialized, so in it you can customize variables -that affect frame appearance as well as the package initialization process, +that affect the package initialization process, such as @code{package-enable-at-startup}, @code{package-load-list}, and @code{package-user-dir}. Note that variables like @code{package-archives} which only affect the installation of new packages, and not the process of commit db12b386537f0a0d36a4759c625ba643e391e4f2 Author: Lars Ingebrigtsen Date: Thu Sep 16 14:18:30 2021 +0200 Clarify test-completion doc string * src/minibuf.c (Ftest_completion): Clarify what it means to be a valid completion (bug#50583). diff --git a/src/minibuf.c b/src/minibuf.c index c9134eff67..a0ba86763f 100644 --- a/src/minibuf.c +++ b/src/minibuf.c @@ -2055,7 +2055,11 @@ See also `completing-read-function'. */) /* Test whether TXT is an exact completion. */ DEFUN ("test-completion", Ftest_completion, Stest_completion, 2, 3, 0, doc: /* Return non-nil if STRING is a valid completion. +For instance, if COLLECTION is a list of strings, this is true if +STRING appears in the list and PREDICATE is satisfied. + Takes the same arguments as `all-completions' and `try-completion'. + If COLLECTION is a function, it is called with three arguments: the values STRING, PREDICATE and `lambda'. */) (Lisp_Object string, Lisp_Object collection, Lisp_Object predicate) commit 373c644fccc20a7b5986b6d0ce2b4dbccdd12deb Author: Stefan Kangas Date: Thu Sep 16 13:58:38 2021 +0200 Remove references to dead packages * etc/themes/manoj-dark-theme.el: Delete references to colortheme and emacs-goodies. diff --git a/etc/themes/manoj-dark-theme.el b/etc/themes/manoj-dark-theme.el index 5a527111d3..e3df40ebe9 100644 --- a/etc/themes/manoj-dark-theme.el +++ b/etc/themes/manoj-dark-theme.el @@ -51,19 +51,16 @@ ;; Similar color variations occur for individual messages in a group; ;; high scoring messages bubble to the top, and have a higher ;; luminance. This color schema has made me slightly faster at -;; reading mail/USENET. +;; reading mail/Usenet. ;; In the message itself, quoted mail messages from different people ;; are color coordinated, with high contrast between citations that are ;; close to each other in the hierarchy, so it is less likely that one ;; misunderstands who said what in a long conversation. -;; The following scheme covers programming languages, Gnus, Erc, mail, -;; org-mode, CUA-mode, apt-utils, bbdb, compilation buffers, changelog -;; mode, diff and ediff, eshell, and more. You need emacs-goodies -;; package on Debian to use this. See the wiki page at -;; https://www.emacswiki.org/cgi-bin/wiki?ColorTheme for details. The -;; project home page is at https://gna.org/projects/color-theme. +;; This theme covers programming languages, Gnus, Erc, mail, org-mode, +;; CUA-mode, apt-utils, bbdb, compilation buffers, changelog mode, +;; diff and ediff, eshell, and more. ;;; Code: commit 8a55d10629b9d53206db2dabc5e2357d7d313af4 Author: Stefan Kangas Date: Thu Sep 16 11:48:08 2021 +0200 Make a redundant idlwave variable obsolete * lisp/progmodes/idlw-help.el (idlwave-help-browse-url-available): Make obsolete. (idlwave-help-check-locations): Don't use above variable. diff --git a/lisp/progmodes/idlw-help.el b/lisp/progmodes/idlw-help.el index c53b9a4775..b90bbedd45 100644 --- a/lisp/progmodes/idlw-help.el +++ b/lisp/progmodes/idlw-help.el @@ -37,10 +37,7 @@ ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; - ;;; Code: -(defvar idlwave-help-browse-url-available t - "Whether browse-url is available.") (require 'browse-url) @@ -332,9 +329,7 @@ Here are all keybindings. (when (and idlwave-help-use-assistant (not (eq (idlwave-help-assistant-available) t))) (message "Cannot locate IDL Assistant, enabling default browser.") - (setq idlwave-help-use-assistant nil) - (unless idlwave-help-browse-url-available - (error "browse-url is not available; install it or IDL Assistant to use HTML help"))))) + (setq idlwave-help-use-assistant nil)))) (defvar idlwave-current-obj_new-class) @@ -1354,6 +1349,8 @@ IDL assistant.") (setq idlwave-help-assistant-socket nil idlwave-help-assistant-process nil))) +(defvar idlwave-help-browse-url-available t) +(make-obsolete-variable 'idlwave-help-browse-url-available nil "28.1") (provide 'idlw-help) (provide 'idlwave-help) commit b049f373ef910f7896be7ba983a84f948a252e29 Author: Stefan Kangas Date: Thu Sep 16 11:31:42 2021 +0200 Various minor checkdoc tweaks * lisp/emacs-lisp/checkdoc.el (checkdoc-symbol-words): Add more "good" words that are used a lot in practice, and where using them doesn't really hurt the quality of the documentation. (checkdoc-proper-noun-list): Add "dired", remove "ispell"; the latter should not always be capitalized. (checkdoc-common-verbs-wrong-voice): Add some more common words. Don't check for "matches" as it leads to too many false positives and almost no fixes in practice. (checkdoc-this-string-valid-engine): Clarify comment. (checkdoc-in-abbreviation-p): Ignore some less common or non-standard abbreviations. diff --git a/lisp/emacs-lisp/checkdoc.el b/lisp/emacs-lisp/checkdoc.el index e117969618..01f2c0d95f 100644 --- a/lisp/emacs-lisp/checkdoc.el +++ b/lisp/emacs-lisp/checkdoc.el @@ -311,7 +311,10 @@ variable `checkdoc-common-verbs-wrong-voice' if you wish to add your own." Do not set this by hand, use a function like `checkdoc-current-buffer' with a universal argument.") -(defcustom checkdoc-symbol-words '("byte-code" "command-line" "top-level") +(defcustom checkdoc-symbol-words + '("beginning-of-line" "byte-code" "command-line" "end-of-line" + "major-mode" "syntax-table" "top-level" "user-error" + "version-control" "window-system") "A list of symbol names (strings) which also happen to make good words. These words are ignored when unquoted symbols are searched for. This should be set in an Emacs Lisp file's local variables." @@ -336,7 +339,7 @@ See Info node `(elisp) Documentation Tips' for background." (not (memq nil (mapcar #'stringp obj))))) (defvar checkdoc-proper-noun-list - '("ispell" "emacs" "lisp") + '("emacs" "lisp" "dired") "List of words (not capitalized) which should be capitalized.") (defvar checkdoc-proper-noun-regexp @@ -368,8 +371,11 @@ See Info node `(elisp) Documentation Tips' for background." ("converts" . "convert") ("creates" . "create") ("destroys" . "destroy") + ("determines" . "determine") ("disables" . "disable") + ("echoes" . "echo") ("executes" . "execute") + ("extends" . "extend") ("evals" . "evaluate") ("evaluates" . "evaluate") ("finds" . "find") @@ -394,7 +400,7 @@ See Info node `(elisp) Documentation Tips' for background." ("looks" . "look") ("makes" . "make") ("marks" . "mark") - ("matches" . "match") + ;;("matches" . "match") ; Leads to almost only false positives. ("moves" . "move") ("notifies" . "notify") ("offers" . "offer") @@ -420,6 +426,7 @@ See Info node `(elisp) Documentation Tips' for background." ("signifies" . "signify") ("sorts" . "sort") ("starts" . "start") + ("steps" . "step") ("stores" . "store") ("switches" . "switch") ("tells" . "tell") @@ -1562,7 +1569,7 @@ mouse-[0-3]\\)\\)\\>")) ;; Ambiguous quoted symbol. When a symbol is both bound and fbound, ;; and is referred to in documentation, it should be prefixed with ;; something to disambiguate it. This check must be before the - ;; 80 column check because it will probably break that. + ;; 80 column check because it might break that. (save-excursion (let ((case-fold-search t) (ret nil) mb me) @@ -2035,7 +2042,10 @@ Examples of abbreviations handled: \"e.g.\", \"i.e.\", \"cf.\"." (seq (any "eE") ".g") ; e.g. (seq (any "iI") "." (any "eE")))) ; i.e. "etc" ; etc. - "vs") ; vs. + "vs" ; vs. + ;; Some non-standard or less common ones that we + ;; might as well ignore. + "Inc" "Univ" "misc" "resp") "."))) (error t))))