commit a952ca5461c590fe194a2f96622603d6ccaebb47 (HEAD, refs/remotes/origin/master) Merge: f410b251fd8 dce31372a60 Author: Po Lu Date: Tue Jul 9 09:33:09 2024 +0800 Merge from savannah/emacs-30 dce31372a60 editorconfig-core-handle.el: Fix regressions in fnmatch h... ed2986494c7 Checkdoc fixes in `url/*.el` 846c0e10ffa Checkdoc fixes in `term/*.el` 3977aa07568 Checkdoc fixes in `mh-e/*.el` 521f740d013 Checkdoc fixes in `calc/*.el` 336aa6ab17a Checkdoc fixes in `textmodes/*.el` e19fd6a22de Checkdoc fixes in `gnus/*.el` 7350457c793 Checkdoc fixes in `eshell/*.el` 23c1ba81ddd Checkdoc fixes in `emulation/*.el` c85f67a66df Checkdoc fixes in `erc/*.el` e392382e2e2 Checkdoc fixes in `vc/*.el` ef7364b070e Checkdoc fixes in `emacs-lisp/*.el` 5fe1ae0e843 Checkdoc fixes in `mail/*.el` e43e9d09986 Checkdoc fixes in `net/*.el` 4c6e9f5b004 Improve `use-package-vc-valid-keywords` docstring format 928180f32be ; * etc/TODO: New item on installing Magit. c193a702dc2 ; Improve a recent change to the documentation 6ebc5d5c278 ; Delete fixed item from etc/TODO: "proced on macOS" 7b2778e3a3d ; Delete fixed NS bug from etc/TODO 84552ff395c Revert "Fix link to major mode variable in docstring" 198063ba643 * etc/TODO: Add item to convert documentation to 'setopt'. 92de67829ca Prefer 'setopt' in browse-url docs 76683853905 ; Improve 'native-comp-debug' documentation commit dce31372a60a9d37591671b8570169c9117e416a Author: Stefan Monnier Date: Mon Jul 8 17:09:31 2024 -0400 editorconfig-core-handle.el: Fix regressions in fnmatch handling * lisp/editorconfig-core-handle.el (editorconfig-core-handle-get-properties-hash): Fix computation of relative file name. (editorconfig-core-handle--fnmatch-p): Handle the case when `pattern` doesn't have a `/` but does match the `/` character. diff --git a/lisp/editorconfig-core-handle.el b/lisp/editorconfig-core-handle.el index 96d0723d9e0..73c26288287 100644 --- a/lisp/editorconfig-core-handle.el +++ b/lisp/editorconfig-core-handle.el @@ -127,9 +127,9 @@ If HANDLE is nil return nil." If HANDLE is nil return nil." (when handle - (let ((hash (make-hash-table)) - (file (file-relative-name file (editorconfig-core-handle-path - handle)))) + (let* ((hash (make-hash-table)) + (dir (file-name-directory (editorconfig-core-handle-path handle))) + (file (file-relative-name file dir))) (dolist (section (editorconfig-core-handle-sections handle)) (cl-loop for (key . value) in (editorconfig-core-handle-section-get-properties section file) do (puthash (intern key) value hash))) @@ -143,7 +143,11 @@ This function is a fnmatch with a few modification for EditorConfig usage." (if (string-match-p "/" pattern) (let ((pattern (replace-regexp-in-string "\\`/" "" pattern))) (editorconfig-fnmatch-p name pattern)) - (editorconfig-fnmatch-p (file-name-nondirectory name) pattern))) + ;; The match is not "anchored" so it can be either in the current dir or + ;; in a subdir. Contrary to Zsh patterns, editorconfig's `**/foo' does + ;; not match `foo', so we need to split the problem into two matches. + (or (editorconfig-fnmatch-p name pattern) + (editorconfig-fnmatch-p name (concat "**/" pattern))))) (defun editorconfig-core-handle--parse-file (conf) "Parse EditorConfig file CONF. commit ed2986494c7c3fb6aaeb7647c6812c4091500222 Author: Stefan Kangas Date: Mon Jul 8 17:49:14 2024 +0200 Checkdoc fixes in `url/*.el` * lisp/url/url-util.el (url-query-key-value-allowed-chars): * lisp/url/url.el (url-retrieve-synchronously): Checkdoc fixes. diff --git a/lisp/url/url-util.el b/lisp/url/url-util.el index f41c5b07ffa..8e958eee0b7 100644 --- a/lisp/url/url-util.el +++ b/lisp/url/url-util.el @@ -378,7 +378,7 @@ These characters are specified in RFC 3986, Appendix A.") (aset vec ?\; nil) vec) "Allowed-character byte mask for keys and values in the query segment of a URI. -url-query-allowed-chars minus '=', '&', and ';'.") +`url-query-allowed-chars' minus '=', '&', and ';'.") ;;;###autoload (defun url-encode-url (url) diff --git a/lisp/url/url.el b/lisp/url/url.el index 0ac2917b213..2bf62d7cfbb 100644 --- a/lisp/url/url.el +++ b/lisp/url/url.el @@ -227,7 +227,7 @@ URL-encoded before it's used." (defun url-retrieve-synchronously (url &optional silent inhibit-cookies timeout) "Retrieve URL synchronously. Return the buffer containing the data, or nil if there are no data -associated with it (the case for dired, info, or mailto URLs that need +associated with it (the case for Dired, info, or mailto URLs that need no further processing). URL is either a string or a parsed URL. If SILENT is non-nil, don't do any messaging while retrieving. commit 846c0e10ffaa13af654e9247e658a088d03d6f34 Author: Stefan Kangas Date: Mon Jul 8 17:47:21 2024 +0200 Checkdoc fixes in `term/*.el` * lisp/term/android-win.el (android-clear-preedit-text): * lisp/term/pgtk-win.el (featurep): * lisp/term/x-win.el (x-clear-preedit-text): Checkdoc fixes. diff --git a/lisp/term/android-win.el b/lisp/term/android-win.el index 3e0f71abf91..df1cdc5143e 100644 --- a/lisp/term/android-win.el +++ b/lisp/term/android-win.el @@ -223,7 +223,7 @@ VALUE should be something suitable for passing to ;; time. This pre-command-hook clears the overlay before any command ;; and should be set whenever a preedit overlay is visible. (defun android-clear-preedit-text () - "Clear the pre-edit overlay and remove itself from pre-command-hook. + "Clear the pre-edit overlay and remove itself from `pre-command-hook'. This function should be installed in `pre-command-hook' whenever preedit text is displayed." (when android-preedit-overlay @@ -629,4 +629,4 @@ accessible to other programs." (provide 'android-win) -;; android-win.el ends here. +;;; android-win.el ends here diff --git a/lisp/term/pgtk-win.el b/lisp/term/pgtk-win.el index 7999d348082..505174048f6 100644 --- a/lisp/term/pgtk-win.el +++ b/lisp/term/pgtk-win.el @@ -27,7 +27,7 @@ (eval-when-compile (require 'cl-lib)) (unless (featurep 'pgtk) - (error "%s: Loading pgtk-win.el but not compiled with PGTK." + (error "%s: Loading pgtk-win.el but not compiled with PGTK" invocation-name)) ;; Documentation-purposes only: actually loaded in loadup.el. diff --git a/lisp/term/x-win.el b/lisp/term/x-win.el index 98dd576fea2..ced2750202b 100644 --- a/lisp/term/x-win.el +++ b/lisp/term/x-win.el @@ -1523,7 +1523,7 @@ This uses `icon-map-list' to map icon file names to stock icon names." ;; time. This pre-command-hook clears the overlay before any command ;; and should be set whenever a preedit overlay is visible. (defun x-clear-preedit-text () - "Clear the pre-edit overlay and remove itself from pre-command-hook. + "Clear the pre-edit overlay and remove itself from `pre-command-hook'. This function should be installed in `pre-command-hook' whenever preedit text is displayed." (when x-preedit-overlay commit f410b251fd8a30360f2b9969957dae3ab6ee5bd8 Author: Stefan Kangas Date: Mon Jul 8 17:41:23 2024 +0200 Make checkdoc recognize "U.S." acronym * lisp/emacs-lisp/checkdoc.el (checkdoc-in-abbreviation-p): Recognize "U.S." acronym. diff --git a/lisp/emacs-lisp/checkdoc.el b/lisp/emacs-lisp/checkdoc.el index 252dd5cbf83..d81eba7e85c 100644 --- a/lisp/emacs-lisp/checkdoc.el +++ b/lisp/emacs-lisp/checkdoc.el @@ -2137,7 +2137,7 @@ Examples of recognized abbreviations: \"e.g.\", \"i.e.\", \"cf.\"." (seq (any "cC") "f") ; cf. (seq (any "eE") ".g") ; e.g. (seq (any "iI") "." (any "eE")) ; i.e. - "a.k.a" "etc" "vs" "N.B" + "a.k.a" "etc" "vs" "N.B" "U.S" ;; Some non-standard or less common ones that we ;; might as well accept. "Inc" "Univ" "misc" "resp") commit 3977aa0756860d771442c69ee018fa7e925d0a62 Author: Stefan Kangas Date: Mon Jul 8 17:39:51 2024 +0200 Checkdoc fixes in `mh-e/*.el` * lisp/mh-e/mh-e.el (mh-tool-bar): * lisp/mh-e/mh-folder.el (mh-folder-mode): * lisp/mh-e/mh-search.el (mh-pick-menu, mh-search-mode): * lisp/mh-e/mh-show.el (mh-show-mode): Checkdoc fixes. diff --git a/lisp/mh-e/mh-e.el b/lisp/mh-e/mh-e.el index 1a535620602..3d686b4a777 100644 --- a/lisp/mh-e/mh-e.el +++ b/lisp/mh-e/mh-e.el @@ -1104,7 +1104,7 @@ and GNU mailutils." :package-version '(MH-E . "8.0")) (defgroup mh-tool-bar nil - "The tool bar" + "The tool bar." :link '(custom-manual "(mh-e)Tool Bar") :prefix "mh-" :group 'mh-e diff --git a/lisp/mh-e/mh-folder.el b/lisp/mh-e/mh-folder.el index 1dae9a600fd..c90537f1502 100644 --- a/lisp/mh-e/mh-folder.el +++ b/lisp/mh-e/mh-folder.el @@ -520,8 +520,8 @@ font-lock is done highlighting.") ;; Autoload cookie needed by desktop.el ;;;###autoload (define-derived-mode mh-folder-mode fundamental-mode "MH-Folder" - "Major MH-E mode for \"editing\" an MH folder scan listing.\\ - + "Major MH-E mode for \"editing\" an MH folder scan listing. +\\ You can show the message the cursor is pointing to, and step through the messages. Messages can be marked for deletion or refiling into another folder; these commands are executed all at once with a diff --git a/lisp/mh-e/mh-search.el b/lisp/mh-e/mh-search.el index 59dad161c11..5ee70ae081d 100644 --- a/lisp/mh-e/mh-search.el +++ b/lisp/mh-e/mh-search.el @@ -539,7 +539,7 @@ group of results." ;;; Search Menu (easy-menu-define - mh-pick-menu mh-search-mode-map "Menu for MH-E Search" + mh-pick-menu mh-search-mode-map "Menu for MH-E Search." '("Search" ["Perform Search" mh-index-do-search t] ["Search with pick" mh-pick-do-search t])) @@ -594,8 +594,8 @@ as well.") (put 'mh-search-mode 'mode-class 'special) (define-derived-mode mh-search-mode fundamental-mode "MH-Search" - "Mode for creating search templates in MH-E.\\ - + "Mode for creating search templates in MH-E. +\\ Edit this template by entering your search criteria in an appropriate header field that is already there, or create a new field yourself. If the string you're looking for could be diff --git a/lisp/mh-e/mh-show.el b/lisp/mh-e/mh-show.el index 0f90fd6f057..96b148ab49c 100644 --- a/lisp/mh-e/mh-show.el +++ b/lisp/mh-e/mh-show.el @@ -818,8 +818,8 @@ operation." ;;;###mh-autoload (define-derived-mode mh-show-mode text-mode "MH-Show" - "Major mode for showing messages in MH-E.\\ - + "Major mode for showing messages in MH-E. +\\ Email addresses and URLs in the message are highlighted if the option `goto-address-highlight-p' is on, which it is by default. To view the web page for a highlighted URL or to send a message commit 521f740d0136924b2931d4fff6868eb0427b946d Author: Stefan Kangas Date: Mon Jul 8 16:44:17 2024 +0200 Checkdoc fixes in `calc/*.el` * lisp/calc/calc.el (calc-embedded-open-close-new-formula-alist): Checkdoc fixes. diff --git a/lisp/calc/calc.el b/lisp/calc/calc.el index f92e4958e33..1bbc297e58c 100644 --- a/lisp/calc/calc.el +++ b/lisp/calc/calc.el @@ -341,7 +341,7 @@ See calc-embedded-open-plain." (defcustom calc-embedded-open-close-new-formula-alist nil - "Alist of major modes with pairs of new formula delimiters used by calc-embedded." + "Alist of major modes with pairs of new formula delimiters used by `calc-embedded'." :type '(alist :key-type (symbol :tag "Major mode") :value-type (list (string :tag "Opening new formula delimiter") (string :tag "Closing new formula delimiter")))) commit 336aa6ab17a25351d54bb66fb66939ca27a6e94a Author: Stefan Kangas Date: Mon Jul 8 17:16:32 2024 +0200 Checkdoc fixes in `textmodes/*.el` * lisp/textmodes/ispell.el (ispell-command-loop): * lisp/textmodes/mhtml-mode.el (mhtml--construct-submode): * lisp/textmodes/page-ext.el (pages-set-delimiter): * lisp/textmodes/refbib.el (r2b-get-field, r2b-put-field): * lisp/textmodes/refer.el (refer-cache-bib-files): * lisp/textmodes/reftex-index.el (reftex-index-phrase-selection-or-word): (reftex-index-phrases-mode): * lisp/textmodes/table.el (table-insert, table--fill-region-strictly): Checkdoc fixes. diff --git a/lisp/textmodes/ispell.el b/lisp/textmodes/ispell.el index caf59995c01..667da10d7a3 100644 --- a/lisp/textmodes/ispell.el +++ b/lisp/textmodes/ispell.el @@ -2416,7 +2416,7 @@ Global `ispell-quit' is set to start location to continue spell session." (progn (set-marker ispell-recursive-edit-marker nil) (error - "Cannot continue ispell from this buffer."))) + "Cannot continue ispell from this buffer"))) (set-marker ispell-recursive-edit-marker nil))) (list word nil)) ; recheck starting at this word. ((= char ?\C-z) diff --git a/lisp/textmodes/mhtml-mode.el b/lisp/textmodes/mhtml-mode.el index e2de6959dc6..987d3d7345c 100644 --- a/lisp/textmodes/mhtml-mode.el +++ b/lisp/textmodes/mhtml-mode.el @@ -86,7 +86,7 @@ code(); "Regexp matching the prefix of buffer-locals we want to capture.") (defun mhtml--construct-submode (mode &rest args) - "A wrapper for make-mhtml--submode that computes the buffer-local variables." + "A wrapper for `make-mhtml--submode' that computes the buffer-local variables." (let ((captured-locals nil) (crucial-captured-locals nil) (submode (apply #'make-mhtml--submode args))) diff --git a/lisp/textmodes/page-ext.el b/lisp/textmodes/page-ext.el index f5f59adb0cf..1681f86b343 100644 --- a/lisp/textmodes/page-ext.el +++ b/lisp/textmodes/page-ext.el @@ -486,7 +486,7 @@ contain matches to the regexp.)") (define-obsolete-function-alias 'set-page-delimiter #'pages-set-delimiter "27.1") (defun pages-set-delimiter (regexp reset-p &optional interactively) - "Set buffer local value of page-delimiter to REGEXP. + "Set buffer local value of `page-delimiter' to REGEXP. Called interactively with a prefix argument, reset `page-delimiter' to its original value. diff --git a/lisp/textmodes/refbib.el b/lisp/textmodes/refbib.el index dd548e00d9b..087e097649e 100644 --- a/lisp/textmodes/refbib.el +++ b/lisp/textmodes/refbib.el @@ -270,13 +270,13 @@ This is in addition to the `r2b-capitalize-title-stop-words'.") (princ (apply (function format) args) r2b-out-buf)) (defun r2b-get-field (var field &optional unique required capitalize) - "Set VAR to string value of FIELD, if any. If none, VAR is set to -nil. If multiple fields appear, then separate values with the -'\\nand\\t\\t', unless UNIQUE is non-nil, in which case log a warning -and just concatenate the values. Trim off leading blanks and tabs on -first line, and trailing blanks and tabs of every line. Log a warning -and set VAR to the empty string if REQUIRED is true. Capitalize as a -title if CAPITALIZE is true. Returns value of VAR." + "Set VAR to string value of FIELD, if any. +If none, VAR is set to nil. If multiple fields appear, then separate +values with the '\\nand\\t\\t', unless UNIQUE is non-nil, in which case +log a warning and just concatenate the values. Trim off leading blanks +and tabs on first line, and trailing blanks and tabs of every line. Log +a warning and set VAR to the empty string if REQUIRED is true. +Capitalize as a title if CAPITALIZE is true. Return value of VAR." (let (item val (not-past-end t)) (r2b-trace "snarfing %s" field) (goto-char (point-min)) @@ -406,9 +406,10 @@ title if CAPITALIZE is true. Returns value of VAR." (defun r2b-put-field (field data &optional abbrevs) - "Print bibtex FIELD = {DATA} if DATA not null; precede -with a comma and newline; if ABBREVS list is given, then -try to replace the {DATA} with an abbreviation." + "Print bibtex FIELD = {DATA} if DATA not null; precede with comma and newline. + +If ABBREVS list is given, then try to replace the {DATA} with an +abbreviation." (if data (let (match nodelim index) ;; multi-line (cond diff --git a/lisp/textmodes/refer.el b/lisp/textmodes/refer.el index 0fbe4a30b11..f5f4be75c03 100644 --- a/lisp/textmodes/refer.el +++ b/lisp/textmodes/refer.el @@ -113,9 +113,9 @@ each time it is needed." (defcustom refer-cache-bib-files t "Variable determining whether the value of `refer-bib-files' should be cached. -If t, initialize the value of refer-bib-files the first time it is used. If -nil, re-read the list of \\.bib files depending on the value of `refer-bib-files' -each time it is needed." +If t, initialize the value of refer-bib-files the first time it is used. +If nil, re-read the list of \\.bib files depending on the value of +`refer-bib-files' each time it is needed." :type 'boolean) (defcustom refer-bib-files-regexp "\\\\bibliography" diff --git a/lisp/textmodes/reftex-index.el b/lisp/textmodes/reftex-index.el index a93afd63855..68efa4fe8a3 100644 --- a/lisp/textmodes/reftex-index.el +++ b/lisp/textmodes/reftex-index.el @@ -1263,7 +1263,7 @@ This gets refreshed in every phrases command.") (defun reftex-index-phrase-selection-or-word (arg) "Add current selection or word at point to the phrases buffer. \\ -When you are in transient-mark-mode and the region is active, the +When you are in `transient-mark-mode' and the region is active, the selection will be used - otherwise the word at point. You get a chance to edit the entry in the phrases buffer - finish with \\[reftex-index-phrases-save-and-return]." @@ -1364,8 +1364,8 @@ If the buffer is non-empty, delete the old header first." ;;;###autoload (define-derived-mode reftex-index-phrases-mode fundamental-mode "Phrases" "Major mode for managing the Index phrases of a LaTeX document. -This buffer was created with RefTeX. \\ - +This buffer was created with RefTeX. +\\ To insert new phrases, use - `C-c \\' in the LaTeX document to copy selection or word - `\\[reftex-index-new-phrase]' in the phrases buffer. diff --git a/lisp/textmodes/table.el b/lisp/textmodes/table.el index 2087fd8271b..918c84bc949 100644 --- a/lisp/textmodes/table.el +++ b/lisp/textmodes/table.el @@ -1456,8 +1456,8 @@ first cell. |-!- | | | +-----+-----+-----+ -Inside a table cell, there are special key bindings. \\ - +Inside a table cell, there are special key bindings. +\\ M-9 \\[table-widen-cell] (or \\[universal-argument] 9 \\[table-widen-cell]) widens the first cell by 9 character width, which results as @@ -1466,7 +1466,7 @@ width, which results as +--------------+-----+-----+ Type TAB \\[table-widen-cell] then type TAB M-2 M-7 \\[table-widen-cell] (or \\[universal-argument] 2 7 \\[table-widen-cell]). Typing -TAB moves the point forward by a cell. The result now looks like this: +TAB moves the point forward by a cell. The result now looks like this: +--------------+------+--------------------------------+ | | |-!- | @@ -5301,8 +5301,8 @@ Current buffer must already be set to the cache buffer." (defun table--fill-region-strictly (beg end) "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." +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)) (error "markerp")) (if (< fill-column 2) commit e19fd6a22de00465b8fa6db574d71d03fa37b11f Author: Stefan Kangas Date: Mon Jul 8 17:07:03 2024 +0200 Checkdoc fixes in `gnus/*.el` * lisp/gnus/gnus-agent.el (gnus-agent-enable-expiration) (gnus-agent-with-refreshed-group, gnus-agentize) (gnus-agent-fetch-headers, gnus-agent-update-files-total-fetched-for) (gnus-agent-update-view-total-fetched-for): * lisp/gnus/gnus-art.el (gnus-article-address-banner-alist) (gnus-default-article-saver, gnus-mime-view-part-as-charset) (gnus-block-private-groups, gnus-article-edit-mode): * lisp/gnus/gnus-dired.el (gnus-dired-mode, gnus-dired-attach) (gnus-dired-find-file-mailcap, gnus-dired-print): * lisp/gnus/gnus-msg.el (gnus-summary-attach-article): * lisp/gnus/gnus-score.el (gnus-home-score-file): * lisp/gnus/gnus-search.el (gnus-search-ignored-newsgroups) (gnus-search-mu-switches, gnus-search-mu-remove-prefix) (gnus-search-thread): * lisp/gnus/gnus-sieve.el (gnus-sieve-string-list): * lisp/gnus/message.el (message-beginning-of-line): * lisp/gnus/mm-url.el: * lisp/gnus/mm-view.el (mm-w3m-setup, mm-setup-w3m): * lisp/gnus/mml-sec.el (mml-signencrypt-style): * lisp/gnus/nndiary.el: * lisp/gnus/nnimap.el (nnimap-server-port, nnimap-use-namespaces) (nnimap-expunge): * lisp/gnus/nnmail.el (nnmail-incoming-coding-system): (nnmail-ignore-broken-references): * lisp/gnus/nnmairix.el (nnmairix-default-group): * lisp/gnus/nntp.el (nntp-report): * lisp/gnus/nnvirtual.el (nnvirtual-update-read-and-marked): (nnvirtual-partition-sequence): * lisp/gnus/spam-stat.el (spam-stat-process-directory-age) (spam-stat-last-saved-at, spam-stat-save): * lisp/gnus/spam.el (spam-enter-ham-BBDB, spam-check-BBDB): Checkdoc fixes. diff --git a/lisp/gnus/gnus-agent.el b/lisp/gnus/gnus-agent.el index 0928b179787..c290f8537e2 100644 --- a/lisp/gnus/gnus-agent.el +++ b/lisp/gnus/gnus-agent.el @@ -153,7 +153,7 @@ this limit." When set to ENABLE, the default, `gnus-agent-expire' will expire old contents from a group's local storage. This value may be overridden to disable expiration in specific categories, topics, and groups. Of -course, you could change gnus-agent-enable-expiration to DISABLE then +course, you could change `gnus-agent-enable-expiration' to DISABLE then enable expiration per categories, topics, and groups." :version "22.1" :group 'gnus-agent @@ -275,14 +275,14 @@ Actually a hash table holding subjects mapped to t.") ;;; (defmacro gnus-agent-with-refreshed-group (group &rest body) - "Performs the body then updates the group's line in the group -buffer. Automatically blocks multiple updates due to recursion." + "Perform the body then update the group's line in the group buffer. +Automatically block multiple updates due to recursion." `(prog1 (let ((gnus-agent-inhibit-update-total-fetched-for t)) ,@body) (when (and gnus-agent-need-update-total-fetched-for (not gnus-agent-inhibit-update-total-fetched-for)) - (with-current-buffer gnus-group-buffer - (setq gnus-agent-need-update-total-fetched-for nil) - (gnus-group-update-group ,group t))))) + (with-current-buffer gnus-group-buffer + (setq gnus-agent-need-update-total-fetched-for nil) + (gnus-group-update-group ,group t))))) (defun gnus-agent-read-file (file) "Load FILE and do a `read' there." @@ -618,8 +618,8 @@ manipulated as follows: (defun gnus-agentize () "Allow Gnus to be an offline newsreader. -The gnus-agentize function is now called internally by gnus when -gnus-agent is set. If you wish to avoid calling gnus-agentize, +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. This will modify the `gnus-setup-news-hook', and @@ -1785,9 +1785,9 @@ variables. Returns the first non-nil value found." (agent-predicate . gnus-agent-predicate))))))) (defun gnus-agent-fetch-headers (group) - "Fetch interesting headers into the agent. The group's overview -file will be updated to include the headers while a list of available -article numbers will be returned." + "Fetch interesting headers into the agent. +The group's overview file will be updated to include the headers while a +list of available article numbers will be returned." (let* ((fetch-all (and gnus-agent-consider-all-articles ;; Do not fetch all headers if the predicate ;; implies that we only consider unread articles. @@ -4059,8 +4059,7 @@ CLEAN is obsolete and ignored." (defun gnus-agent-update-files-total-fetched-for (group delta &optional method path) - "Update, or set, the total disk space used by the articles that the -agent has fetched." + "Update or set total disk space used by articles that the agent has fetched." (when gnus-agent-total-fetched-hashtb (gnus-agent-with-refreshed-group group @@ -4099,9 +4098,8 @@ agent has fetched." (defun gnus-agent-update-view-total-fetched-for (group agent-over &optional method path) - "Update, or set, the total disk space used by the .agentview and -.overview files. These files are calculated separately as they can be -modified." + "Update or set the total disk space used by the .agentview and .overview files. +These files are calculated separately as they can be modified." (when gnus-agent-total-fetched-hashtb (gnus-agent-with-refreshed-group group diff --git a/lisp/gnus/gnus-art.el b/lisp/gnus/gnus-art.el index 9f313108089..5151ad1c1b8 100644 --- a/lisp/gnus/gnus-art.el +++ b/lisp/gnus/gnus-art.el @@ -330,8 +330,7 @@ to match a mail address in the From: header, BANNER is one of a symbol If ADDRESS matches author's mail address, it will remove things like advertisements. For example: -\((\"@yoo-hoo\\\\.co\\\\.jp\\\\\\='\" . \"\\n_+\\nDo You Yoo-hoo!\\\\?\\n.*\\n.*\\n\")) -" +\((\"@yoo-hoo\\\\.co\\\\.jp\\\\\\='\" . \"\\n_+\\nDo You Yoo-hoo!\\\\?\\n.*\\n.*\\n\"))" :type '(repeat (cons (regexp :tag "Address") @@ -557,15 +556,15 @@ command, and friends such as `gnus-summary-save-article-rmail'. Gnus provides the following functions: -* gnus-summary-save-in-rmail (Rmail format) -* gnus-summary-save-in-mail (Unix mail format) -* gnus-summary-save-in-folder (MH folder) -* gnus-summary-save-in-file (article format) -* gnus-summary-save-body-in-file (article body) -* gnus-summary-save-in-vm (use VM's folder format) -* gnus-summary-write-to-file (article format -- overwrite) -* gnus-summary-write-body-to-file (article body -- overwrite) -* gnus-summary-save-in-pipe (article format) +* `gnus-summary-save-in-rmail' (Rmail format) +* `gnus-summary-save-in-mail' (Unix mail format) +* `gnus-summary-save-in-folder' (MH folder) +* `gnus-summary-save-in-file' (article format) +* `gnus-summary-save-body-in-file' (article body) +* `gnus-summary-save-in-vm' (use VM's folder format) +* `gnus-summary-write-to-file' (article format -- overwrite) +* `gnus-summary-write-body-to-file' (article body -- overwrite) +* `gnus-summary-save-in-pipe' (article format) The symbol of each function may have the following properties: @@ -5519,8 +5518,7 @@ CHARSET may either be a string or a symbol." (setcdr type (cons (cons 'charset charset) (cdr type))))))) (defun gnus-mime-view-part-as-charset (&optional handle arg event) - "Insert the MIME part under point into the current buffer using the -specified charset." + "Insert MIME part under point into current buffer using specified charset." (interactive (list nil current-prefix-arg last-nonmenu-event) gnus-article-mode) (save-excursion @@ -7304,8 +7302,7 @@ If given a prefix, show the hidden text instead." (point))))))) (defun gnus-block-private-groups (group) - "Allows images in newsgroups to be shown, blocks images in all -other groups." + "Allows images in newsgroups to be shown, blocks images in all other groups." (if (or (gnus-news-group-p group) (gnus-member-of-valid 'global group) (member group gnus-global-groups)) @@ -7389,7 +7386,7 @@ other groups." (define-derived-mode gnus-article-edit-mode message-mode "Article Edit" "Major mode for editing articles. -This is an extended text-mode. +This is an extended `text-mode'. \\{gnus-article-edit-mode-map}" (make-local-variable 'gnus-article-edit-done-function) diff --git a/lisp/gnus/gnus-dired.el b/lisp/gnus/gnus-dired.el index f33c5f7f2e5..f21d84b40c6 100644 --- a/lisp/gnus/gnus-dired.el +++ b/lisp/gnus/gnus-dired.el @@ -24,15 +24,15 @@ ;;; Commentary: ;; This package provides utility functions for intersections of gnus -;; and dired. To enable the gnus-dired-mode minor mode which will +;; and Dired. To enable the gnus-dired-mode minor mode which will ;; have the effect of installing keybindings in dired-mode, place the ;; following in your ~/.gnus: ;; (require 'gnus-dired) ;, isn't needed due to autoload cookies ;; (add-hook 'dired-mode-hook #'turn-on-gnus-dired-mode) -;; Note that if you visit dired buffers before your ~/.gnus file has -;; been read, those dired buffers won't have the keybindings in +;; Note that if you visit Dired buffers before your ~/.gnus file has +;; been read, those Dired buffers won't have the keybindings in ;; effect. To get around that problem, you may want to add the above ;; statements to your ~/.emacs instead. @@ -81,7 +81,7 @@ See `mail-user-agent' for more information." (function :tag "Other"))) (define-minor-mode gnus-dired-mode - "Minor mode for intersections of gnus and dired. + "Minor mode for intersections of gnus and Dired. \\{gnus-dired-mode-map}" :keymap gnus-dired-mode-map @@ -119,7 +119,7 @@ See `mail-user-agent' for more information." ;; Method to attach files to a mail composition. (defun gnus-dired-attach (files-to-attach) - "Attach dired's marked files to a gnus message composition. + "Attach Dired's marked files to a gnus message composition. If called non-interactively, FILES-TO-ATTACH should be a list of filenames." (interactive @@ -180,7 +180,7 @@ filenames." (autoload 'mailcap-parse-mailcaps "mailcap" "" t) (defun gnus-dired-find-file-mailcap (&optional file-name arg) - "In dired, visit FILE-NAME according to the mailcap file. + "In Dired, visit FILE-NAME according to the mailcap file. If ARG is non-nil, open it in a new buffer." (interactive (list (file-name-sans-versions (dired-get-filename) t) @@ -215,7 +215,7 @@ If ARG is non-nil, open it in a new buffer." "File no longer exists; type \\`g' to update Dired buffer"))))) (defun gnus-dired-print (&optional file-name print-to) - "In dired, print FILE-NAME according to the mailcap file. + "In Dired, print FILE-NAME according to the mailcap file. If there is no print command, print in a PostScript image. If the optional argument PRINT-TO is nil, send the image to the printer. diff --git a/lisp/gnus/gnus-msg.el b/lisp/gnus/gnus-msg.el index b18ede58fbf..705dbfa10f2 100644 --- a/lisp/gnus/gnus-msg.el +++ b/lisp/gnus/gnus-msg.el @@ -1918,7 +1918,7 @@ can be attached to them. If not, a new Message buffer is created. This command uses the process/prefix convention, so if you -process-mark several articles, they will all be attached." +`process-mark' several articles, they will all be attached." (interactive "P" gnus-summary-mode) (let ((buffers (message-buffers)) destination) diff --git a/lisp/gnus/gnus-score.el b/lisp/gnus/gnus-score.el index 31ce1328e37..f91299ed3c0 100644 --- a/lisp/gnus/gnus-score.el +++ b/lisp/gnus/gnus-score.el @@ -190,7 +190,7 @@ It can be: * `(regexp file-name ...)' If the `regexp' matches the group name, the first `file-name' will be used as the home score file. (Multiple filenames are - allowed so that one may use gnus-score-file-single-match-alist to + allowed so that one may use `gnus-score-file-single-match-alist' to set this variable.) * A function. diff --git a/lisp/gnus/gnus-search.el b/lisp/gnus/gnus-search.el index 9cff2e2f109..c25163ac770 100644 --- a/lisp/gnus/gnus-search.el +++ b/lisp/gnus/gnus-search.el @@ -135,8 +135,7 @@ transformed." 'gnus-search-ignored-newsgroups "28.1") (defcustom gnus-search-ignored-newsgroups "" - "A regexp to match newsgroups in the active file that should -be skipped when searching." + "Regexp matching newsgroups in the active file to skip when searching." :version "24.1" :type 'regexp) @@ -357,7 +356,7 @@ This can also be set per-server." (defcustom gnus-search-mu-switches nil "A list of strings, to be given as additional arguments to mu. -Note that this should be a list. I.e., do NOT use the following: +Note that this should be a list. I.e., do NOT use the following: (setq gnus-search-mu-switches \"-u -r\") Instead, use this: (setq gnus-search-mu-switches \\='(\"-u\" \"-r\")) @@ -367,7 +366,7 @@ This can also be set per-server." (defcustom gnus-search-mu-remove-prefix (expand-file-name "~/Mail/") "A prefix to remove from the mu results to get a group name. -Usually this will be set to the path to your mail directory. This +Usually this will be set to the path to your mail directory. This can also be set per-server." :version "29.1" :type 'directory) @@ -2186,7 +2185,7 @@ remaining string, then adds all that to the top-level spec." (defun gnus-search-thread (header &optional group server) "Find articles in the thread containing HEADER from GROUP on SERVER. -If gnus-refer-thread-use-search is nil only the current group is +If `gnus-refer-thread-use-search' is nil only the current group is checked for articles; if t all groups on the server containing the article's group will be searched; if a list then all servers in this list will be searched. If possible the newly found diff --git a/lisp/gnus/gnus-sieve.el b/lisp/gnus/gnus-sieve.el index 04af180a9d2..7b4561b52f5 100644 --- a/lisp/gnus/gnus-sieve.el +++ b/lisp/gnus/gnus-sieve.el @@ -133,8 +133,7 @@ Return nil if no rule could be guessed." For example: \(gnus-sieve-string-list \\='(\"to\" \"cc\")) - => \"[\\\"to\\\", \\\"cc\\\"]\" -" + => \"[\\\"to\\\", \\\"cc\\\"]\"" (concat "[\"" (mapconcat #'identity list "\", \"") "\"]")) (defun gnus-sieve-test-list (list) diff --git a/lisp/gnus/message.el b/lisp/gnus/message.el index 0a46f3a2fed..98f63571389 100644 --- a/lisp/gnus/message.el +++ b/lisp/gnus/message.el @@ -6605,8 +6605,7 @@ they are." (sit-for 0)) (defcustom message-beginning-of-line t - "Whether \\\\[message-beginning-of-line]\ - goes to beginning of header values." + "Whether \\\\[message-beginning-of-line] goes to beginning of header values." :version "22.1" :group 'message-buffers :link '(custom-manual "(message)Movement") @@ -6668,7 +6667,7 @@ beginning of line. When called without a prefix argument, header value spanning multiple lines is treated as a single line. Otherwise, even if N is 1, when point is on a continuation header line, it will be -moved to the beginning " +moved to the beginning." (interactive "^p" message-mode) (cond ;; Go to beginning of header or beginning of line. diff --git a/lisp/gnus/mm-url.el b/lisp/gnus/mm-url.el index be6c9bb7977..788e4b294a0 100644 --- a/lisp/gnus/mm-url.el +++ b/lisp/gnus/mm-url.el @@ -21,7 +21,7 @@ ;;; Commentary: -;; Some code is stolen from w3 and url packages. Some are moved from +;; Some code is stolen from w3 and url packages. Some are moved from ;; nnweb. ;; TODO: Support POST, cookie. diff --git a/lisp/gnus/mm-view.el b/lisp/gnus/mm-view.el index 223da19a164..1df634d3c9b 100644 --- a/lisp/gnus/mm-view.el +++ b/lisp/gnus/mm-view.el @@ -108,14 +108,14 @@ This is only used if `mm-inline-large-images' is set to (delete-region b (+ b 2))))))) (defvar mm-w3m-setup nil - "Whether gnus-article-mode has been setup to use emacs-w3m.") + "Whether `gnus-article-mode' has been setup to use emacs-w3m.") ;; External. (declare-function w3m-detect-meta-charset "ext:w3m" ()) (declare-function w3m-region "ext:w3m" (start end &optional url charset)) (defun mm-setup-w3m () - "Setup gnus-article-mode to use emacs-w3m." + "Setup `gnus-article-mode' to use emacs-w3m." (unless mm-w3m-setup (require 'w3m) (unless (assq 'gnus-article-mode w3m-cid-retrieve-function-alist) diff --git a/lisp/gnus/mml-sec.el b/lisp/gnus/mml-sec.el index 98f8ebbcbcd..141e00223db 100644 --- a/lisp/gnus/mml-sec.el +++ b/lisp/gnus/mml-sec.el @@ -151,9 +151,10 @@ you use Bcc headers to encrypt e-mails to yourself." ;;; Configuration/helper functions (defun mml-signencrypt-style (method &optional style) - "Function for setting/getting the signencrypt-style used. Takes two -arguments, the method (e.g. \"pgp\") and optionally the mode -\(e.g. combined). If the mode is omitted, the current value is returned. + "Function for setting/getting the signencrypt-style used. +Takes two arguments, the method (e.g. \"pgp\") and optionally the mode +\(e.g. combined). If the mode is omitted, the current value is +returned. For example, if you prefer to use combined sign & encrypt with smime, putting the following in your Gnus startup file will diff --git a/lisp/gnus/nndiary.el b/lisp/gnus/nndiary.el index b6f423ee2f8..97a4600603f 100644 --- a/lisp/gnus/nndiary.el +++ b/lisp/gnus/nndiary.el @@ -30,7 +30,7 @@ ;; =========== ;; nndiary is a mail back end designed to handle mails as diary event -;; reminders. It is now fully documented in the Gnus manual. +;; reminders. It is now fully documented in the Gnus manual. ;; Bugs / Todo: @@ -43,19 +43,19 @@ ;; * We could allow a keyword like `ask' in X-Diary-* headers, that would mean ;; "ask for value upon reception of the message". ;; * We could add an optional header X-Diary-Reminders to specify a special -;; reminders value for this message. Suggested by Jody Klymak. +;; reminders value for this message. Suggested by Jody Klymak. ;; * We should check messages validity in other circumstances than just -;; moving an article from somewhere else (request-accept). For instance, +;; moving an article from somewhere else (request-accept). For instance, ;; when editing / saving and so on. ;; Remarks: ;; ======= -;; * nnoo. NNDiary is very similar to nnml. This makes the idea of using nnoo -;; (to derive nndiary from nnml) natural. However, my experience with nnoo +;; * nnoo. NNDiary is very similar to nnml. This makes the idea of using nnoo +;; (to derive nndiary from nnml) natural. However, my experience with nnoo ;; is that for reasonably complex back ends like this one, nnoo is a burden -;; rather than an help. It's tricky to use, not everything can be inherited, +;; rather than an help. It's tricky to use, not everything can be inherited, ;; what can be inherited and when is not very clear, and you've got to be ;; very careful because a little mistake can fuck up your other back ends, ;; especially because their variables will be use instead of your real ones. @@ -64,16 +64,16 @@ ;; IMHO, nnoo is actually badly designed. A much simpler, and yet more ;; powerful one would be to make *real* functions and variables for a new -;; back end based on another. Lisp is a reflexive language so that's a very +;; back end based on another. Lisp is a reflexive language so that's a very ;; easy thing to do: inspect the function's form, replace occurrences of ;; (even in strings) with , and you're done. ;; * nndiary-get-new-mail, nndiary-mail-source and nndiary-split-methods: ;; NNDiary has some experimental parts, in the sense Gnus normally uses only -;; one mail back ends for mail retrieval and splitting. This back end is -;; also an attempt to make it behave differently. For Gnus developers: as +;; one mail back ends for mail retrieval and splitting. This back end is +;; also an attempt to make it behave differently. For Gnus developers: as ;; you can see if you snarf into the code, that was not a very difficult -;; thing to do. Something should be done about the respooling breakage +;; thing to do. Something should be done about the respooling breakage ;; though. diff --git a/lisp/gnus/nnimap.el b/lisp/gnus/nnimap.el index c61dfecfa7a..7b0e42ff89d 100644 --- a/lisp/gnus/nnimap.el +++ b/lisp/gnus/nnimap.el @@ -51,7 +51,7 @@ (defvoo nnimap-server-port nil "The IMAP port used. -If nnimap-stream is `ssl', this will default to `imaps'. If not, +If `nnimap-stream' is `ssl', this will default to `imaps'. If not, it will default to `imap'.") (defvoo nnimap-use-namespaces nil @@ -59,7 +59,7 @@ it will default to `imap'.") If in Gnus your folder names in all start with (e.g.) `INBOX', you probably want to set this to t. The effects of this are purely cosmetic, but changing this variable will affect the -names of your nnimap groups. ") +names of your nnimap groups.") (defvoo nnimap-stream 'undecided "How nnimap talks to the IMAP server. @@ -102,15 +102,15 @@ Possible choices are nil (use default methods), `anonymous', (defvoo nnimap-expunge 'on-exit "When to expunge deleted messages. If `never', deleted articles are marked with the IMAP \\Delete -flag but not automatically expunged. If `immediately', deleted +flag but not automatically expunged. If `immediately', deleted articles are immediately expunged (this requires the server to -support the UID EXPUNGE command). If `on-exit', deleted articles +support the UID EXPUNGE command). If `on-exit', deleted articles are flagged, and all flagged articles are expunged when the group is closed. For backwards compatibility, this variable may also be set to t -or nil. If the server supports UID EXPUNGE, both t and nil are -equivalent to `immediately'. If the server does not support UID +or nil. If the server supports UID EXPUNGE, both t and nil are +equivalent to `immediately'. If the server does not support UID EXPUNGE nil is equivalent to `never', while t will immediately expunge ALL articles that are currently flagged as deleted (i.e., potentially not only the article that was just deleted).") diff --git a/lisp/gnus/nnmail.el b/lisp/gnus/nnmail.el index a9f5b89c6fe..afc6a7470ac 100644 --- a/lisp/gnus/nnmail.el +++ b/lisp/gnus/nnmail.el @@ -602,7 +602,7 @@ These will be logged to the \"*nnmail split*\" buffer." (defvar nnmail-incoming-coding-system mm-text-coding-system - "Coding system used in reading inbox") + "Coding system used in reading inbox.") (defcustom nnmail-pathname-coding-system nil "Coding system for file name." @@ -1306,7 +1306,7 @@ See `nnmail-ignore-broken-references'." :type 'regexp) (defun nnmail-ignore-broken-references () - "Ignore the References line and use In-Reply-To + "Ignore the References line and use In-Reply-To. Eudora has a broken References line, but an OK In-Reply-To." (goto-char (point-min)) diff --git a/lisp/gnus/nnmairix.el b/lisp/gnus/nnmairix.el index c517f85db9b..434e907d536 100644 --- a/lisp/gnus/nnmairix.el +++ b/lisp/gnus/nnmairix.el @@ -35,7 +35,7 @@ ;; Commentary on the code: nnmairix sits between Gnus and the "real" ;; back end which handles the mail (currently nnml, nnimap and -;; nnmaildir were tested). I know this is all a bit hacky, but so far +;; nnmaildir were tested). I know this is all a bit hacky, but so far ;; it works for me. This is the first back end I've written for Gnus, ;; so I'd appreciate any comments, suggestions, bug reports (and, of ;; course, patches) for improving nnmairix. @@ -368,8 +368,9 @@ wrong count of total articles shown by Gnus.") its maildir mail folders (e.g. the Dovecot IMAP server or mutt).") (defvoo nnmairix-default-group nil - "Default search group. This is the group which is used for all -temporary searches, e.g. nnmairix-search.") + "Default search group. +This is the group which is used for all temporary searches, +e.g. nnmairix-search.") ;;; === Internal variables diff --git a/lisp/gnus/nntp.el b/lisp/gnus/nntp.el index fe165662988..393fd01a5d1 100644 --- a/lisp/gnus/nntp.el +++ b/lisp/gnus/nntp.el @@ -300,9 +300,10 @@ backend doesn't catch this error.") (defvar nntp--report-1 nil) (defun nntp-report (&rest args) - "Report an error from the nntp backend. The first string in ARGS -can be a format string. For some commands, the failed command may be -retried once before actually displaying the error report." + "Report an error from the nntp backend. +The first string in ARGS can be a format string. For some commands, the +failed command may be retried once before actually displaying the error +report." (if nntp--report-1 (progn ;; Throw out to nntp-with-open-group-error so that the connection may diff --git a/lisp/gnus/nnvirtual.el b/lisp/gnus/nnvirtual.el index 9eea0f89996..79747dca31f 100644 --- a/lisp/gnus/nnvirtual.el +++ b/lisp/gnus/nnvirtual.el @@ -436,7 +436,8 @@ lines have the correct component server prefix." (defun nnvirtual-update-read-and-marked (read-p update-p) "Copy marks from the virtual group to the component groups. If READ-P is not nil, update the (un)read status of the components. -If UPDATE-P is not nil, call gnus-group-update-group on the components." +If UPDATE-P is not nil, call `gnus-group-update-group' on the +components." (when nnvirtual-current-group (let ((unreads (and read-p (nnvirtual-partition-sequence @@ -642,7 +643,7 @@ then it is left out of the result." (defun nnvirtual-partition-sequence (articles) "Return an association list of component article numbers. -These are indexed by elements of nnvirtual-component-groups, based on +These are indexed by elements of `nnvirtual-component-groups', based on the sequence ARTICLES of virtual article numbers. ARTICLES should be sorted, and can be a compressed sequence. If any of the article numbers has no corresponding component article, then it is left out of diff --git a/lisp/gnus/spam-stat.el b/lisp/gnus/spam-stat.el index f4ad9e48f6f..431cb5e7d7a 100644 --- a/lisp/gnus/spam-stat.el +++ b/lisp/gnus/spam-stat.el @@ -183,7 +183,7 @@ say, `with-spam-stat-max-buffer-size'." :type '(repeat sexp)) (defcustom spam-stat-process-directory-age 90 - "Max. age of files to be processed in directory, in days. + "Maximum age of files to be processed in directory, in days. When using `spam-stat-process-spam-directory' or `spam-stat-process-non-spam-directory', only files that have been touched in this many days will be considered. Without @@ -192,7 +192,7 @@ will start to take a very long time." :type 'integer) (defvar spam-stat-last-saved-at nil - "Time stamp of last change of spam-stat-file on this run") + "Time stamp of last change of `spam-stat-file' on this run.") (defvar spam-stat-syntax-table (let ((table (copy-syntax-table text-mode-syntax-table))) @@ -394,7 +394,7 @@ Use `spam-stat-ngood', `spam-stat-nbad', `spam-stat-good', ;; Saving and Loading (defun spam-stat-save (&optional force) - "Save the `spam-stat' hash table as lisp file. + "Save the `spam-stat' hash table as Lisp file. With a prefix argument save unconditionally." (interactive "P") (when (or force spam-stat-dirty) diff --git a/lisp/gnus/spam.el b/lisp/gnus/spam.el index 1ae214ea4fa..ed667dae31f 100644 --- a/lisp/gnus/spam.el +++ b/lisp/gnus/spam.el @@ -2053,7 +2053,7 @@ See the Info node `(gnus)Fancy Mail Splitting' for more details." (add-hook 'bbdb-change-hook #'spam-clear-cache-BBDB)) (defun spam-enter-ham-BBDB (addresses &optional remove) - "Enter an address into the BBDB; implies ham (non-spam) sender" + "Enter an address into the BBDB; implies ham (non-spam) sender." (dolist (from addresses) (when (stringp from) (let* ((parsed-address (gnus-extract-address-components from)) @@ -2091,7 +2091,7 @@ See the Info node `(gnus)Fancy Mail Splitting' for more details." (bbdb-gethash (downcase net)))) (defun spam-check-BBDB () - "Mail from people in the BBDB is classified as ham or non-spam" + "Mail from people in the BBDB is classified as ham or non-spam." (let ((net (message-fetch-field "from"))) (when net (setq net (nth 1 (gnus-extract-address-components net))) commit 7350457c793f5f6b7cd331b85ef5779ca17a1c27 Author: Stefan Kangas Date: Mon Jul 8 16:50:17 2024 +0200 Checkdoc fixes in `eshell/*.el` * lisp/eshell/em-elecslash.el: * lisp/eshell/em-extpipe.el: * lisp/eshell/em-pred.el (eshell-get-delimited-modifier-argument): * lisp/eshell/esh-cmd.el (eshell--unmark-deferrable) (eshell-named-command-hook): * lisp/eshell/esh-module.el (eshell-module--feature-name): * lisp/eshell/esh-util.el (eshell-find-delimiter): Checkdoc fixes. diff --git a/lisp/eshell/em-elecslash.el b/lisp/eshell/em-elecslash.el index 60f2c6e4039..a06e5be721d 100644 --- a/lisp/eshell/em-elecslash.el +++ b/lisp/eshell/em-elecslash.el @@ -108,4 +108,4 @@ insertion." (insert "/"))))) (provide 'em-elecslash) -;;; esh-elecslash.el ends here +;;; em-elecslash.el ends here diff --git a/lisp/eshell/em-extpipe.el b/lisp/eshell/em-extpipe.el index 4c92653a3a3..dd06a055755 100644 --- a/lisp/eshell/em-extpipe.el +++ b/lisp/eshell/em-extpipe.el @@ -217,4 +217,4 @@ as though it were Eshell syntax." (error "Unhandled external pipeline in input text")) (provide 'em-extpipe) -;;; esh-extpipe.el ends here +;;; em-extpipe.el ends here diff --git a/lisp/eshell/em-pred.el b/lisp/eshell/em-pred.el index 0be262641ea..a9274e7c60d 100644 --- a/lisp/eshell/em-pred.el +++ b/lisp/eshell/em-pred.el @@ -417,7 +417,7 @@ delimiter. If CHAINED-P is true, then another delimited modifier argument will immediately follow this one. In this case, when the opening and closing delimiters are the same, update point to be just -before the closing delimiter. This allows modifiers like +before the closing delimiter. This allows modifiers like `:s/match/repl' to work as expected." (when-let* ((open (char-after)) (close (cdr (assoc open eshell-pred-delimiter-pairs))) diff --git a/lisp/eshell/esh-cmd.el b/lisp/eshell/esh-cmd.el index aaae19df5d6..0b3137127d2 100644 --- a/lisp/eshell/esh-cmd.el +++ b/lisp/eshell/esh-cmd.el @@ -154,8 +154,7 @@ To prevent a command from executing at all, set :type 'hook) (defcustom eshell-named-command-hook nil - "A set of functions called before -a named command is invoked. + "A set of functions called before a named command is invoked. Each function will be passed the command name and arguments that were passed to `eshell-named-command'. @@ -816,7 +815,7 @@ current ones (see `eshell-duplicate-handles')." This changes COMMAND in-place by converting function calls listed in `eshell-deferrable-commands' to their non-deferrable forms so that Eshell doesn't erroneously allow deferring it. For example, -`eshell-named-command' becomes `eshell-named-command*', " +`eshell-named-command' becomes `eshell-named-command*'." (let ((cmd command)) (when (memq (car cmd) '(let progn)) (setq cmd (car (last cmd)))) diff --git a/lisp/eshell/esh-module.el b/lisp/eshell/esh-module.el index db808f8597a..a139bc186d7 100644 --- a/lisp/eshell/esh-module.el +++ b/lisp/eshell/esh-module.el @@ -99,7 +99,7 @@ extension module; if nil, KIND defaults to `extension'." (let ((module-name (symbol-name module)) (prefix (cond ((eq kind 'core) "esh-") ((memq kind '(extension nil)) "em-") - (t (error "unknown module kind %s" kind))))) + (t (error "Unknown module kind %s" kind))))) (if (string-match "^eshell-\\(.*\\)" module-name) (concat prefix (match-string 1 module-name)) (error "Invalid Eshell module name: %s" module)))) diff --git a/lisp/eshell/esh-util.el b/lisp/eshell/esh-util.el index e2657dbabd8..46083184aaa 100644 --- a/lisp/eshell/esh-util.el +++ b/lisp/eshell/esh-util.el @@ -288,7 +288,7 @@ The value returned is the last form in BODY." (defun eshell-find-delimiter (open close &optional bound reverse-p backslash-p) "From point, find the CLOSE delimiter corresponding to OPEN. -The matching is bounded by BOUND. If REVERSE-P is non-nil, +The matching is bounded by BOUND. If REVERSE-P is non-nil, process the region backwards. If BACKSLASH-P is non-nil, or OPEN and CLOSE are different commit 23c1ba81ddd8e5b74d0d6e17aa53e38a04f86729 Author: Stefan Kangas Date: Mon Jul 8 16:43:27 2024 +0200 Checkdoc fixes in `emulation/*.el` * lisp/emulation/cua-base.el: * lisp/emulation/viper-mous.el (viper-parse-mouse-key): * lisp/emulation/viper.el (viper-major-mode-modifier-list): Checkdoc fixes. diff --git a/lisp/emulation/cua-base.el b/lisp/emulation/cua-base.el index fb6a8515d9e..8b62b04c99c 100644 --- a/lisp/emulation/cua-base.el +++ b/lisp/emulation/cua-base.el @@ -154,7 +154,7 @@ ;; ;; To start a rectangle, use [C-return] and extend it using the normal ;; movement keys (up, down, left, right, home, end, C-home, -;; C-end). Once the rectangle has the desired size, you can cut or +;; C-end). Once the rectangle has the desired size, you can cut or ;; copy it using C-x and C-c (or C-w and M-w), and you can ;; subsequently insert it - as a rectangle - using C-v (or C-y). So ;; the only new command you need to know to work with cua-mode diff --git a/lisp/emulation/viper-mous.el b/lisp/emulation/viper-mous.el index 322027b56c4..fb31983f1f2 100644 --- a/lisp/emulation/viper-mous.el +++ b/lisp/emulation/viper-mous.el @@ -456,7 +456,7 @@ bindings in the Viper manual." (if (eq 'up event-type) "mouse-3" "down-mouse-3")) (t (error - "%S: invalid button number, %S" key-var key))) + "%S: Invalid button number, %S" key-var key))) meta-spec (if (memq 'meta key) "M-" "") shift-spec diff --git a/lisp/emulation/viper.el b/lisp/emulation/viper.el index 287292a24dc..b62e11b2649 100644 --- a/lisp/emulation/viper.el +++ b/lisp/emulation/viper.el @@ -486,7 +486,7 @@ unless it is coming up in a wrong Viper state." "List specifying how to modify the various major modes to enable some Viperisms. The list has the structure: ((mode viper-state keymap) (mode viper-state keymap) ...). If `mode' is on the list, the `keymap' will be made active (on -the minor-mode-map-alist) in the specified viper state. +the `minor-mode-map-alist') in the specified viper state. If you change this list, have to restart Emacs for the change to take effect. However, if you did the change through the customization widget, then Emacs needs to be restarted only if you deleted a triple mode-state-keymap from the commit c85f67a66dfc9b3333a466a5fcd313425889ee6e Author: Stefan Kangas Date: Mon Jul 8 16:41:02 2024 +0200 Checkdoc fixes in `erc/*.el` * lisp/erc/erc-backend.el (erc-server-parameters): * lisp/erc/erc-button.el (erc-button--display-error-with-buttons): * lisp/erc/erc-dcc.el (erc-dcc-member): * lisp/erc/erc-fill.el (erc-fill-wrap-refill-buffer): * lisp/erc/erc-speedbar.el (erc-speedbar--last-ran): * lisp/erc/erc-stamp.el (erc-stamp--current-time): * lisp/erc/erc-track.el (erc-make-mode-line-buffer-name): * lisp/erc/erc.el (erc-interactive-display, erc-modules, erc-cmd-CLEAR) (erc-update-current-channel-member, erc--format-user-modes) (erc-check-text-conversion): Checkdoc fixes. diff --git a/lisp/erc/erc-backend.el b/lisp/erc/erc-backend.el index 01213c9724d..9aedc110067 100644 --- a/lisp/erc/erc-backend.el +++ b/lisp/erc/erc-backend.el @@ -260,7 +260,7 @@ or where PARAMETER is a string and VALUE is a string or nil. For compatibility, a raw parameter of the form \"FOO=\" becomes (\"FOO\" . \"\") even though it's equivalent to the preferred -canonical form \"FOO\" and its lisp representation (\"FOO\"). +canonical form \"FOO\" and its Lisp representation (\"FOO\"). Some examples of possible parameters sent by servers: CHANMODES=b,k,l,imnpst - list of supported channel modes diff --git a/lisp/erc/erc-button.el b/lisp/erc/erc-button.el index 8cf8991e57c..c158b443b89 100644 --- a/lisp/erc/erc-button.el +++ b/lisp/erc/erc-button.el @@ -815,7 +815,7 @@ and `apropos' for other symbols." (defun erc-button--display-error-with-buttons (from to fun nick-p &optional data regexp) - "Replace command in region with keys and return new bounds" + "Replace command in region with keys and return new bounds." (let* ((o (buffer-substring from to)) (s (substitute-command-keys o)) (erc-button-face (and (equal o s) erc-button-face))) diff --git a/lisp/erc/erc-dcc.el b/lisp/erc/erc-dcc.el index b8e16df755b..dec499e727f 100644 --- a/lisp/erc/erc-dcc.el +++ b/lisp/erc/erc-dcc.el @@ -173,7 +173,7 @@ ARGS is a plist. Return nil on no match. The property :nick is treated specially, if it contains a `!' character, it is treated as a nick!user@host string, and compared with the :nick property -value of the individual elements using string-equal. Otherwise it is +value of the individual elements using `string-equal'. Otherwise it is compared with `erc-nick-equal-p' which is IRC case-insensitive." (let ((list erc-dcc-list) result test) diff --git a/lisp/erc/erc-fill.el b/lisp/erc/erc-fill.el index 9d969b39ad2..defef6fe414 100644 --- a/lisp/erc/erc-fill.el +++ b/lisp/erc/erc-fill.el @@ -799,7 +799,7 @@ necessary after revealing previously hidden text with commands like `erc-match-toggle-hidden-fools'." (interactive "P") (unless erc-fill-wrap-mode - (user-error "Module `fill-wrap' not active in current buffer.")) + (user-error "Module `fill-wrap' not active in current buffer")) (save-excursion (with-silent-modifications (let* ((rep (make-progress-reporter diff --git a/lisp/erc/erc-speedbar.el b/lisp/erc/erc-speedbar.el index 3e8c110a31b..e45fb9a7adf 100644 --- a/lisp/erc/erc-speedbar.el +++ b/lisp/erc/erc-speedbar.el @@ -548,7 +548,7 @@ associated with an ERC session." "Speedbar update period.") (defvar-local erc-speedbar--last-ran nil - "When non-nil, a lisp timestamp updated when the speedbar timer runs.") + "When non-nil, a Lisp timestamp updated when the speedbar timer runs.") (defun erc-speedbar--prod-dframe-timer (&rest _) "Refresh speedbar if dormant for `erc-speedbar--force-update-interval-secs'." diff --git a/lisp/erc/erc-stamp.el b/lisp/erc/erc-stamp.el index 7788f0b2d68..bebc1d0be38 100644 --- a/lisp/erc/erc-stamp.el +++ b/lisp/erc/erc-stamp.el @@ -210,11 +210,11 @@ from entering them and instead jump over them." (defvar erc-stamp--current-time nil "The current time when calling `erc-insert-timestamp-function'. -Specifically, this is the same lisp time object used to create +Specifically, this is the same Lisp time object used to create the stamp passed to `erc-insert-timestamp-function'.") (cl-defgeneric erc-stamp--current-time () - "Return a lisp time object to associate with an IRC message. + "Return a Lisp time object to associate with an IRC message. This becomes the message's `erc--ts' text property." (erc-compat--current-lisp-time)) diff --git a/lisp/erc/erc-track.el b/lisp/erc/erc-track.el index 40e83fff974..39a4775ddca 100644 --- a/lisp/erc/erc-track.el +++ b/lisp/erc/erc-track.el @@ -760,7 +760,7 @@ the number of unread messages, according to variables `erc-track-showcount' and `erc-track-showcount-string'. If `erc-track-use-faces' is true and FACES are provided, format -STRING with them. When the mouse hovers above the button, STRING +STRING with them. When the mouse hovers above the button, STRING is displayed according to `erc-track-mouse-face'." ;; We define a new sparse keymap every time, because 1. this data ;; structure is very small, the alternative would require us to diff --git a/lisp/erc/erc.el b/lisp/erc/erc.el index b0be96d7b35..7cc7bf56252 100644 --- a/lisp/erc/erc.el +++ b/lisp/erc/erc.el @@ -1868,7 +1868,7 @@ the value of this option is DISPLAY-FUNCTION." "How to display buffers as a result of user interaction. This affects commands like /QUERY and /JOIN when issued interactively at the prompt. It does not apply when calling a -handler for such a command, like `erc-cmd-JOIN', from lisp code. +handler for such a command, like `erc-cmd-JOIN', from Lisp code. See `erc-buffer-display' for a full description of available values. @@ -2269,7 +2269,7 @@ buffer rather than a server buffer.") list match menu move-to-prompt netsplit networks readonly ring stamp track) "Modules to enable while connecting. -When modifying this option in lisp code, use a Custom-friendly +When modifying this option in Lisp code, use a Custom-friendly facilitator, like `setopt', or call `erc-update-modules' afterward. This ensures a consistent ordering and disables removed modules. It also gives packages access to the hook @@ -4476,7 +4476,7 @@ Called with position indicating boundary of interval to be excised.") (defun erc-cmd-CLEAR () "Clear messages in current buffer after informing active modules. Expect modules to perform housekeeping tasks to withstand the -disruption. When called from lisp code, only clear messages up +disruption. When called from Lisp code, only clear messages up to but not including the one occupying the current line." (with-silent-modifications (let ((max (if (>= (point) erc-insert-marker) @@ -7288,7 +7288,7 @@ status switches among VOICE, HALFOP, OP, ADMIN, and OWNER to be the symbol `on' or `off' when needing to influence a new or existing `erc-channel-user' object's `status' slot. Likewise, when UPDATE-MESSAGE-TIME is non-nil, update or initialize the -`last-message-time' slot to the current-time. If changes occur, +`last-message-time' slot to the `current-time'. If changes occur, including creation, run `erc-channel-members-changed-hook'. Return non-nil when meaningful changes, including creation, have occurred. @@ -9173,7 +9173,7 @@ Currently only used by the option `erc-prompt-format'.") ;; As of ERC 5.6, this is identical to the away variant aside from ;; the var names and `eq', which isn't important. (defun erc--format-user-modes () - "Return server's user modes as a string" + "Return server's user modes as a string." (and-let* ((indicator (erc-with-server-buffer (or erc--user-modes-indicator (setq erc--user-modes-indicator (list ""))))) @@ -9730,7 +9730,7 @@ or `erc-kill-buffer-hook' if any other buffer." (defun erc-check-text-conversion () "Check if point is within the ERC prompt and toggle text conversion. If `text-conversion-style' is not `action' if point is within the -prompt or `nil' otherwise, set it to such a value, so as to +prompt or nil otherwise, set it to such a value, so as to guarantee that the input method functions properly for the purpose of typing within the ERC prompt." (when (and (eq major-mode 'erc-mode) commit dd8d5d57df51bcd066323d068b852e9373871584 Author: Pip Cet Date: Mon Jul 8 14:34:45 2024 +0000 perl-mode: fix bug introduced in bd86a6c4fde * lisp/progmodes/perl-mode.el (perl-calculate-indent): Use `save-excursion' around code that modifies point. diff --git a/lisp/progmodes/perl-mode.el b/lisp/progmodes/perl-mode.el index ff71970d41b..13d5d7f9451 100644 --- a/lisp/progmodes/perl-mode.el +++ b/lisp/progmodes/perl-mode.el @@ -1128,8 +1128,8 @@ Returns (parse-state) if line starts inside a string." ;; Move back over whitespace before the openbrace. ;; If openbrace is not first nonwhite thing on the line, ;; add the perl-brace-imaginary-offset. - (progn (skip-chars-backward " \t") - (if (bolp) 0 perl-brace-imaginary-offset)) + (save-excursion (skip-chars-backward " \t") + (if (bolp) 0 perl-brace-imaginary-offset)) (perl-indent-new-calculate 'virtual)))))))) (defun perl-backward-to-noncomment () commit e392382e2e26ea6d6afa459621c289007c8ea77c Author: Stefan Kangas Date: Mon Jul 8 14:37:29 2024 +0200 Checkdoc fixes in `vc/*.el` * lisp/vc/ediff-init.el (ediff-start-narrowed) (ediff-buffer-values-orig-A, ediff-buffer-values-orig-B) (ediff-buffer-values-orig-C, ediff-buffer-values-orig-Ancestor): * lisp/vc/ediff-mult.el: * lisp/vc/ediff-ptch.el (ediff-get-patch-buffer): * lisp/vc/emerge.el (emerge-before-flag, emerge-after-flag): * lisp/vc/vc-dav.el (vc-dav-checkin): * lisp/vc/vc-git.el (vc-git-command): * lisp/vc/vc-hg.el (vc-hg-command): * lisp/vc/vc-src.el (vc-src-command): * lisp/vc/vc-svn.el (vc-svn-command): * lisp/vc/vc.el (vc-checkin): Checkdoc fixes. diff --git a/lisp/vc/ediff-init.el b/lisp/vc/ediff-init.el index c5eda873b5e..1b478d3f9b7 100644 --- a/lisp/vc/ediff-init.el +++ b/lisp/vc/ediff-init.el @@ -594,7 +594,7 @@ highlighted using ASCII flags." (ediff-defvar-local ediff-visible-bounds nil) (ediff-defvar-local ediff-start-narrowed t - "Non-nil means start narrowed, if doing ediff-windows-* or ediff-regions-*") + "Non-nil means start narrowed, if doing ediff-windows-* or ediff-regions-*.") (ediff-defvar-local ediff-quit-widened t "Non-nil means: when finished, Ediff widens buffers A/B. Actually, Ediff restores the scope of visibility that existed at startup.") @@ -624,13 +624,13 @@ It's a number rather than string.") (ediff-defvar-local ediff-buffer-values-orig-A nil - "The original values of ediff-protected-variables for buffer A.") + "The original values of `ediff-protected-variables' for buffer A.") (ediff-defvar-local ediff-buffer-values-orig-B nil - "The original values of ediff-protected-variables for buffer B.") + "The original values of `ediff-protected-variables' for buffer B.") (ediff-defvar-local ediff-buffer-values-orig-C nil - "The original values of ediff-protected-variables for buffer C.") + "The original values of `ediff-protected-variables' for buffer C.") (ediff-defvar-local ediff-buffer-values-orig-Ancestor nil - "The original values of ediff-protected-variables for buffer Ancestor.") + "The original values of `ediff-protected-variables' for buffer Ancestor.") (defconst ediff-buffer-values-orig-alist '((A . ediff-buffer-values-orig-A) diff --git a/lisp/vc/ediff-mult.el b/lisp/vc/ediff-mult.el index 66d4935cd75..b320c7d1f49 100644 --- a/lisp/vc/ediff-mult.el +++ b/lisp/vc/ediff-mult.el @@ -43,7 +43,7 @@ ;; (...) ...) ;; The function ediff-make-new-meta-list-element can be used to create ;; 2nd and subsequent elements of that list (i.e., after the -;; description header). See ediff-make-new-meta-list-element for the +;; description header). See ediff-make-new-meta-list-element for the ;; explanation of the two nil placeholders in such elements. ;; ;; There is API for extracting the components of the members of the diff --git a/lisp/vc/ediff-ptch.el b/lisp/vc/ediff-ptch.el index 2d5d4609890..3b76964327a 100644 --- a/lisp/vc/ediff-ptch.el +++ b/lisp/vc/ediff-ptch.el @@ -542,8 +542,8 @@ are two possible targets for this %spatch. However, these files do not exist." (defun ediff-get-patch-buffer (&optional arg patch-buf) "Obtain patch buffer. If patch is already in a buffer---use it. -Else, read patch file into a new buffer. If patch buffer is passed as an -optional argument, then use it." +Else, read patch file into a new buffer. If patch buffer is passed as +an optional argument, then use it." (let ((last-nonmenu-event t) ; Emacs: don't use dialog box last-command-event) ; XEmacs: don't use dialog box diff --git a/lisp/vc/emerge.el b/lisp/vc/emerge.el index 5328ebc73ad..ca48f2f3c7b 100644 --- a/lisp/vc/emerge.el +++ b/lisp/vc/emerge.el @@ -128,14 +128,14 @@ copied to the designated output file." :type 'boolean) (defcustom emerge-before-flag "vvvvvvvvvvvvvvvvvvvv\n" - "Flag placed above the highlighted block of code. Must end with newline. -Must be set before Emerge is loaded, or emerge-new-flags must be run -after setting." + "Flag placed above the highlighted block of code. +Must end with newline. Must be set before Emerge is loaded, or +`emerge-new-flags' must be run after setting." :type 'string) (defcustom emerge-after-flag "^^^^^^^^^^^^^^^^^^^^\n" - "Flag placed below the highlighted block of code. Must end with newline. -Must be set before Emerge is loaded, or emerge-new-flags must be run -after setting." + "Flag placed below the highlighted block of code. +Must end with newline. Must be set before Emerge is loaded, or +`emerge-new-flags' must be run after setting." :type 'string) ;; Hook variables diff --git a/lisp/vc/vc-dav.el b/lisp/vc/vc-dav.el index ae2cf149771..0e85e71de40 100644 --- a/lisp/vc/vc-dav.el +++ b/lisp/vc/vc-dav.el @@ -1,6 +1,6 @@ ;;; vc-dav.el --- vc.el support for WebDAV -*- lexical-binding: t; -*- -;; Copyright (C) 2001, 2004-2024 Free Software Foundation, Inc. +;; Copyright (C) 2001-2024 Free Software Foundation, Inc. ;; Author: Bill Perry ;; Keywords: url, vc @@ -82,7 +82,7 @@ See `vc-checkout-model' for a list of possible values." ) (defun vc-dav-checkin (_url _comment &optional _rev) - "Commit changes in URL to WebDAV. COMMENT is used as a check-in comment." + "Commit changes in URL to WebDAV. COMMENT is used as a check-in comment." ;; This should PUT the resource and release any locks that we hold. ) diff --git a/lisp/vc/vc-git.el b/lisp/vc/vc-git.el index 0541b16d625..e8257c5dbd0 100644 --- a/lisp/vc/vc-git.el +++ b/lisp/vc/vc-git.el @@ -2177,7 +2177,7 @@ This command shares argument histories with \\[rgrep] and \\[grep]." (defun vc-git-command (buffer okstatus file-or-list &rest flags) "A wrapper around `vc-do-command' for use in vc-git.el. -The difference to vc-do-command is that this function always invokes +The difference to `vc-do-command' is that this function always invokes `vc-git-program'." (let ((coding-system-for-read (or coding-system-for-read vc-git-log-output-coding-system)) diff --git a/lisp/vc/vc-hg.el b/lisp/vc/vc-hg.el index 7de41a2ae50..876d86dc24f 100644 --- a/lisp/vc/vc-hg.el +++ b/lisp/vc/vc-hg.el @@ -1553,7 +1553,7 @@ This runs the command \"hg merge\"." (defun vc-hg-command (buffer okstatus file-or-list &rest flags) "A wrapper around `vc-do-command' for use in vc-hg.el. -This function differs from vc-do-command in that it invokes +This function differs from `vc-do-command' in that it invokes `vc-hg-program', and passes `vc-hg-global-switches' to it before FLAGS." ;; Disable pager. (let ((process-environment (cons "HGPLAIN=1" process-environment)) diff --git a/lisp/vc/vc-src.el b/lisp/vc/vc-src.el index c85c90f7897..27f58cb3369 100644 --- a/lisp/vc/vc-src.el +++ b/lisp/vc/vc-src.el @@ -211,7 +211,7 @@ For a description of possible values, see `vc-check-master-templates'." (defun vc-src-command (buffer file-or-list &rest flags) "A wrapper around `vc-do-command' for use in vc-src.el. -This function differs from vc-do-command in that it invokes `vc-src-program'." +This function differs from `vc-do-command' in that it invokes `vc-src-program'." (let (file-list) (cond ((stringp file-or-list) (setq file-list (list "--" file-or-list))) diff --git a/lisp/vc/vc-svn.el b/lisp/vc/vc-svn.el index ae281e54519..d1d4204d055 100644 --- a/lisp/vc/vc-svn.el +++ b/lisp/vc/vc-svn.el @@ -661,7 +661,7 @@ NAME is assumed to be a URL." (defun vc-svn-command (buffer okstatus file-or-list &rest flags) "A wrapper around `vc-do-command' for use in vc-svn.el. -The difference to vc-do-command is that this function always invokes `svn', +The difference to `vc-do-command' is that this function always invokes `svn', and that it passes `vc-svn-global-switches' to it before FLAGS." (apply #'vc-do-command (or buffer "*vc*") okstatus vc-svn-program file-or-list (if (stringp vc-svn-global-switches) diff --git a/lisp/vc/vc.el b/lisp/vc/vc.el index 22d7d2f1e33..597a1622f5a 100644 --- a/lisp/vc/vc.el +++ b/lisp/vc/vc.el @@ -1691,10 +1691,12 @@ Type \\[vc-next-action] to check in changes.") "Please explain why you stole the lock. Type \\`C-c C-c' when done")))) (defun vc-checkin (files backend &optional comment initial-contents rev patch-string) - "Check in FILES. COMMENT is a comment string; if omitted, a -buffer is popped up to accept a comment. If INITIAL-CONTENTS is -non-nil, then COMMENT is used as the initial contents of the log -entry buffer. + "Check in FILES. + +COMMENT is a comment string; if omitted, a buffer is popped up to accept +a comment. If INITIAL-CONTENTS is non-nil, then COMMENT is used as the +initial contents of the log entry buffer. + The optional argument REV may be a string specifying the new revision level (only supported for some older VCSes, like RCS and CVS). The optional argument PATCH-STRING is a string to check in as a patch. commit ef7364b070e416810de0861c78dbdedf183ee067 Author: Stefan Kangas Date: Mon Jul 8 14:30:37 2024 +0200 Checkdoc fixes in `emacs-lisp/*.el` * lisp/emacs-lisp/bytecomp.el (byte-compile-free-vars-warn) (byte-compile-out): * lisp/emacs-lisp/eldoc.el (eldoc-documentation-functions): * lisp/emacs-lisp/find-func.el (find-ert-deftest-regexp): * lisp/emacs-lisp/macroexp.el (byte-compile-form-stack): Checkdoc fixes. diff --git a/lisp/emacs-lisp/bytecomp.el b/lisp/emacs-lisp/bytecomp.el index d59e89bd7de..88167fc7ebd 100644 --- a/lisp/emacs-lisp/bytecomp.el +++ b/lisp/emacs-lisp/bytecomp.el @@ -3832,7 +3832,7 @@ This assumes the function has the `important-return-value' property." (defun byte-compile-free-vars-warn (arg var &optional assignment) "Warn if symbol VAR refers to a free variable. VAR must not be lexically bound. -ARG is a position argument, used by byte-compile-warn-x. +ARG is a position argument, used by `byte-compile-warn-x'. If optional argument ASSIGNMENT is non-nil, this is treated as an assignment (i.e. `setq')." (unless (or (not (byte-compile-warning-enabled-p 'free-vars var)) @@ -5488,7 +5488,7 @@ OP and OPERAND are as passed to `byte-compile-out'." (defun byte-compile-out (op &optional operand) "Push the operation onto `byte-compile-output'. OP is an opcode, a symbol. OPERAND is either nil or a number or -a one-element list of a lisp form." +a one-element list of a Lisp form." (when (and (consp operand) (null (cdr operand))) (setq operand (byte-run-strip-symbol-positions operand))) (push (cons op operand) byte-compile-output) diff --git a/lisp/emacs-lisp/eldoc.el b/lisp/emacs-lisp/eldoc.el index 24afd03fbe6..417c0145be4 100644 --- a/lisp/emacs-lisp/eldoc.el +++ b/lisp/emacs-lisp/eldoc.el @@ -462,7 +462,7 @@ documentation-displaying frontends. For example, KEY can be: The additional KEY `:origin' is always added by ElDoc, its VALUE being the member of `eldoc-documentation-functions' where -DOCSTRING originated. `eldoc-display-functions' may use this +DOCSTRING originated. `eldoc-display-functions' may use this information to organize display of multiple docstrings. Finally, major modes should modify this hook locally, for diff --git a/lisp/emacs-lisp/find-func.el b/lisp/emacs-lisp/find-func.el index 411602ef166..ce783983b77 100644 --- a/lisp/emacs-lisp/find-func.el +++ b/lisp/emacs-lisp/find-func.el @@ -125,7 +125,7 @@ should insert the feature name." (defcustom find-ert-deftest-regexp "(ert-deftest +'%s" - "The regexp used to search for an ert-deftest definition. + "The regexp used to search for an `ert-deftest' definition. Note it must contain a `%s' at the place where `format' should insert the feature name." :type 'regexp diff --git a/lisp/emacs-lisp/macroexp.el b/lisp/emacs-lisp/macroexp.el index bb4797cac8b..4524eccc7ef 100644 --- a/lisp/emacs-lisp/macroexp.el +++ b/lisp/emacs-lisp/macroexp.el @@ -37,7 +37,7 @@ most deeply nested form. Normally a form is manually pushed onto the list at the beginning of `byte-compile-form', etc., and manually popped off at its end. This is to preserve the data in it in the event of a -condition-case handling a signaled error.") +`condition-case' handling a signaled error.") (defmacro macroexp--with-extended-form-stack (expr &rest body) "Evaluate BODY with EXPR pushed onto `byte-compile-form-stack'." commit 5fe1ae0e843b9f3d0bac5a2d28c23c7210caee9d Author: Stefan Kangas Date: Mon Jul 8 14:24:33 2024 +0200 Checkdoc fixes in `mail/*.el` * lisp/mail/feedmail.el (feedmail-mail-send-hook-splitter) (feedmail-queue-runner-message-sender): * lisp/mail/mail-extr.el (mail-extr-nuke-outside-range): * lisp/mail/rmail.el (rmail-automatic-folder-directives) (rmail-summary-displayed): * lisp/mail/rmailmm.el (rmail-mime-searching): * lisp/mail/sendmail.el (mail-mode): * lisp/mail/supercite.el (sc-mail-last-header-nuked-p): Checkdoc fixes. diff --git a/lisp/mail/feedmail.el b/lisp/mail/feedmail.el index 165aafae1f7..ec618940641 100644 --- a/lisp/mail/feedmail.el +++ b/lisp/mail/feedmail.el @@ -1318,7 +1318,7 @@ Then add the functions you want called to either `feedmail-mail-send-hook-queued' or `feedmail-mail-send-hook', as appropriate. The distinction is that `feedmail-mail-send-hook' will be called when you send mail from a composition -buffer (typically by typing C-c C-c), whether the message is sent +buffer (typically by typing \\`C-c C-c'), whether the message is sent immediately or placed in the queue or drafts directory. `feedmail-mail-send-hook-queued' is called when messages are being sent from the queue directory, typically via a call to @@ -1443,10 +1443,11 @@ Called for each message read back out of the queue directory with a single argument, the optional argument used in the call to `feedmail-run-the-queue' or `feedmail-run-the-queue-no-prompts'. Interactively, that argument will be the prefix argument. -Most people want `mail-send' (bound to C-c C-s in mail-mode), but here's +\\ +Most people want `mail-send' (bound to \\[mail-send] in `mail-mode'), but here's your chance to have something different. The default value is just a wrapper function which discards the optional argument and calls -mail-send. If you are a VM user, you might like vm-mail-send, though +`mail-send'. If you are a VM user, you might like vm-mail-send, though you really don't need that. Called with funcall, not call-interactively." :version "24.1" ; changed default :group 'feedmail-queue diff --git a/lisp/mail/mail-extr.el b/lisp/mail/mail-extr.el index cfdbc1b2509..083bab62cab 100644 --- a/lisp/mail/mail-extr.el +++ b/lisp/mail/mail-extr.el @@ -618,7 +618,7 @@ Unless NO-REPLACE is true, at each of the positions in LIST-SYMBOL which lie outside of the range, one character at that position is replaced with a SPC." (or (memq no-replace '(t nil)) - (error "no-replace must be t or nil, evaluable at macroexpand-time")) + (error "`no-replace' must be t or nil, evaluable at macroexpand-time")) `(let ((temp ,list-symbol) ch) (while temp diff --git a/lisp/mail/rmail.el b/lisp/mail/rmail.el index f22161f766d..5e3633d221c 100644 --- a/lisp/mail/rmail.el +++ b/lisp/mail/rmail.el @@ -519,8 +519,7 @@ For a given message, Rmail applies only the first matching directive. Examples: (\"/dev/null\" \"from\" \"@spam.com\") ; delete all mail from spam.com - (\"RMS\" \"from\" \"rms@\") ; save all mail from RMS. -" + (\"RMS\" \"from\" \"rms@\") ; save all mail from RMS." :group 'rmail :version "21.1" :type '(repeat (sexp :tag "Directive"))) @@ -4315,7 +4314,7 @@ In fact, the non-nil value returned is the summary buffer itself." rmail-summary-buffer)) (defun rmail-summary-displayed () - "t if in RMAIL buffer and an associated summary buffer is displayed." + "Return t if in RMAIL buffer and an associated summary buffer is displayed." (and rmail-summary-buffer (get-buffer-window rmail-summary-buffer))) (defcustom rmail-redisplay-summary nil diff --git a/lisp/mail/rmailmm.el b/lisp/mail/rmailmm.el index 422fe3a7227..b4a0e92136e 100644 --- a/lisp/mail/rmailmm.el +++ b/lisp/mail/rmailmm.el @@ -170,7 +170,7 @@ The value is usually nil, and bound to non-nil while inserting MIME entities.") (defvar rmail-mime-searching nil - "Bound to T inside `rmail-search-mime-message' to suppress expensive + "Bound to t inside `rmail-search-mime-message' to suppress expensive operations such as HTML decoding") ;;; MIME-entity object diff --git a/lisp/mail/sendmail.el b/lisp/mail/sendmail.el index d54fb51dfd3..a720df51d14 100644 --- a/lisp/mail/sendmail.el +++ b/lisp/mail/sendmail.el @@ -671,8 +671,8 @@ switching to, the `*mail*' buffer. See also `mail-setup-hook'." "Major mode for editing mail to be sent. Like Text Mode but with these additional commands: -\\[mail-send] mail-send (send the message) -\\[mail-send-and-exit] mail-send-and-exit (send the message and exit) +\\[mail-send] `mail-send' (send the message) +\\[mail-send-and-exit] `mail-send-and-exit' (send the message and exit) Here are commands that move to a header field (and create it if there isn't): \\[mail-to] move to To: \\[mail-subject] move to Subj: @@ -681,9 +681,9 @@ Here are commands that move to a header field (and create it if there isn't): \\[mail-mail-reply-to] move to Mail-Reply-To: \\[mail-mail-followup-to] move to Mail-Followup-To: \\[mail-text] move to message text. -\\[mail-signature] mail-signature (insert `mail-signature-file' file). -\\[mail-yank-original] mail-yank-original (insert current message, in Rmail). -\\[mail-fill-yanked-message] mail-fill-yanked-message (fill what was yanked). +\\[mail-signature] `mail-signature' (insert `mail-signature-file' file). +\\[mail-yank-original] `mail-yank-original' (insert current message, in Rmail). +\\[mail-fill-yanked-message] `mail-fill-yanked-message' (fill what was yanked). \\[mail-insert-file] insert a text file into the message. \\[mail-add-attachment] attach to the message a file as binary attachment. Turning on Mail mode runs the normal hooks `text-mode-hook' and diff --git a/lisp/mail/supercite.el b/lisp/mail/supercite.el index 9104feb6219..add1582d72a 100644 --- a/lisp/mail/supercite.el +++ b/lisp/mail/supercite.el @@ -727,7 +727,7 @@ If optional ATTRIBS-P is non-nil, the key/value pair is placed in ;; mail header nuking (defvar sc-mail-last-header-nuked-p nil - "True if the last header was nuked.") + "Non-nil if the last header was nuked.") (defun sc-mail-nuke-line () "Nuke the current mail header line." commit e43e9d09986e23d021afb56b4ced440ae8784e33 Author: Stefan Kangas Date: Mon Jul 8 14:10:46 2024 +0200 Checkdoc fixes in `net/*.el` * lisp/net/ange-ftp.el: * lisp/net/dictionary.el (dictionary-tool-bar-map): * lisp/net/eudc.el (eudc-translate-query) (eudc-translate-attribute-list) (eudc-format-inline-expansion-result, eudc-bookmark-server): * lisp/net/eww.el (eww-check-text-conversion): * lisp/net/rcirc.el (rcirc-server-name): * lisp/net/tramp-adb.el (tramp-adb-handle-get-remote-uid): * lisp/net/tramp-cmds.el (tramp-recompile-elpa-command-completion-p): * lisp/net/tramp-crypt.el (tramp-crypt-command-completion-p): * lisp/net/tramp-message.el (tramp-debug-buffer-command-completion-p): * lisp/net/tramp-sh.el (tramp-use-connection-share): * lisp/net/tramp.el (tramp-command-completion-p): Checkdoc fixes. diff --git a/lisp/net/ange-ftp.el b/lisp/net/ange-ftp.el index 7eb66bb062b..4ea57ee6572 100644 --- a/lisp/net/ange-ftp.el +++ b/lisp/net/ange-ftp.el @@ -227,14 +227,14 @@ ;; Tips for using ange-ftp: ;; -;; 1. For dired to work on a host which marks symlinks with a trailing @ in +;; 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 ;; 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 +;; the side effect that Dired will have problems with symlinks whose names ;; end in an @. If you get yourself into this situation then editing -;; dired's ls-switches to remove "F", will temporarily fix things. +;; Dired's ls-switches to remove "F", will temporarily fix things. ;; ;; 2. If you know that you are connecting to a certain non-UNIX machine ;; frequently, and ange-ftp seems to be unable to guess its host-type, @@ -257,8 +257,8 @@ ;; 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 +;; 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 @@ -266,7 +266,7 @@ ;; 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 +;; remote Dired listings would take their (buffer-local) value of ;; dired-no-confirm from this alist. Who votes for this? ;; --------------------------------------------------------------------- @@ -317,7 +317,7 @@ ;; 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 ;; 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 ;; reasoning being that it reasonable to view old versions of a file, but @@ -514,7 +514,7 @@ ;; containing spaces, but beware that the remote ftpd may not like them ;; much. ;; -;; 12. The dired support for non-Unix-like systems does not currently work. +;; 12. The Dired support for non-Unix-like systems does not currently work. ;; It needs to be reimplemented by modifying the parse-...-listing ;; functions to convert the directory listing to ls -l format. ;; @@ -524,8 +524,8 @@ ;; 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 -;; dired buffer will be automatically reverted, which will allow ange-ftp +;; 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. @@ -611,9 +611,9 @@ ;; Thanks to Jamie Zawinski for bugfixes and for ideas such as gateways. ;; ;; Thanks to Ken Laprade for improved .netrc parsing, password reading, and -;; dired / shell auto-loading. +;; Dired / shell auto-loading. ;; -;; Thanks to Sebastian Kremer for dired support and for many ideas and +;; Thanks to Sebastian Kremer for Dired support and for many ideas and ;; bugfixes. ;; ;; Thanks to Joe Wells for bugfixes, the original non-UNIX system support, diff --git a/lisp/net/dictionary.el b/lisp/net/dictionary.el index b12f3fa4368..f17dc160997 100644 --- a/lisp/net/dictionary.el +++ b/lisp/net/dictionary.el @@ -472,7 +472,7 @@ Otherwise, `dictionary-search' displays definitions in a *Dictionary* buffer." :vert-only t :help "Go backwards in history.") map) - "Like the default `tool-bar-map', but with additions for Dictionary mode") + "Like the default `tool-bar-map', but with additions for Dictionary mode.") ;;;###autoload (define-derived-mode dictionary-mode special-mode "Dictionary" diff --git a/lisp/net/eudc.el b/lisp/net/eudc.el index ea90e4a7e77..da8955d52c9 100644 --- a/lisp/net/eudc.el +++ b/lisp/net/eudc.el @@ -382,7 +382,7 @@ The translation is done according to When REVERSE is nil or omitted, the attribute names are translated from EUDC generic names to protocol-specific -names. When REVERSE is non-nil, the translation is from +names. When REVERSE is non-nil, the translation is from protocol-specific names back to EUDC generic names." (if eudc-protocol-attributes-translation-alist (mapcar (lambda (attribute) @@ -406,7 +406,7 @@ The translation is done according to When REVERSE is nil or omitted, the attribute names are translated from EUDC generic names to protocol-specific -names. When REVERSE is non-nil, the translation is from +names. When REVERSE is non-nil, the translation is from protocol-specific names back to EUDC generic names." (if eudc-protocol-attributes-translation-alist (let (trans) @@ -918,7 +918,7 @@ non-nil, collect results from all servers." (if valid-comment-given comment nil))) (progn (error "Error: the function referenced by \ -`eudc-inline-expansion-format' is expected to return a list.") +`eudc-inline-expansion-format' is expected to return a list") nil)))) ;; fallback behavior (nil function, or non-matching type) @@ -1110,7 +1110,7 @@ queries the server for the existing fields and displays a corresponding form." (eudc-install-menu) (if eudc-ignore-options-file (warn "Not saving bookmark due to `eudc-ignore-options-file'\ - customization. Instead, customize `eudc-server-hotlist' to include %s:%s" + customization. Instead, customize `eudc-server-hotlist' to include %s:%s" protocol server) (eudc-save-options)))) diff --git a/lisp/net/eww.el b/lisp/net/eww.el index 94bfd333fa9..f9db0559853 100644 --- a/lisp/net/eww.el +++ b/lisp/net/eww.el @@ -1306,7 +1306,7 @@ This consults the entries in `eww-readable-urls' (which see)." "Check if point is within a field and toggle text conversion. Set `text-conversion-style' to the value `action' if it isn't already and point is within the prompt field, or if -`text-conversion-style' is `nil', so as to guarantee that +`text-conversion-style' is nil, so as to guarantee that the input method functions properly for the purpose of typing within text input fields." (when (and (eq major-mode 'eww-mode) diff --git a/lisp/net/rcirc.el b/lisp/net/rcirc.el index b913ba9e0a3..659035d4acb 100644 --- a/lisp/net/rcirc.el +++ b/lisp/net/rcirc.el @@ -1197,7 +1197,7 @@ With no argument or nil as argument, use the current buffer." "Return PROCESS server name, given by the 001 response." (with-rcirc-process-buffer process (or rcirc-server-name - (warn "server name for process %S unknown" process)))) + (warn "Server name for process %S unknown" process)))) (defun rcirc-nick (process) "Return PROCESS nick." diff --git a/lisp/net/tramp-adb.el b/lisp/net/tramp-adb.el index 5b1c4ba5b19..b26a93fc6e4 100644 --- a/lisp/net/tramp-adb.el +++ b/lisp/net/tramp-adb.el @@ -919,7 +919,7 @@ will be used." (defun tramp-adb-handle-get-remote-uid (vec id-format) "Like `tramp-get-remote-uid' for Tramp files. - ID-FORMAT valid values are `string' and `integer'." +ID-FORMAT valid values are `string' and `integer'." (tramp-adb-send-command vec "id") (tramp-read-id-output vec) (tramp-get-connection-property vec (format "uid-%s" id-format))) diff --git a/lisp/net/tramp-cmds.el b/lisp/net/tramp-cmds.el index ecb9071eb57..5b2646a0b03 100644 --- a/lisp/net/tramp-cmds.el +++ b/lisp/net/tramp-cmds.el @@ -630,7 +630,7 @@ If the buffer runs `dired', the buffer is reverted." ;;;###tramp-autoload (defun tramp-recompile-elpa-command-completion-p (_symbol _buffer) "A predicate for `tramp-recompile-elpa'. -It is completed by \"M-x TAB\" only if package.el is loaded, and +It is completed by `M-x TAB' only if package.el is loaded, and Tramp is an installed ELPA package." ;; We cannot apply `package-installed-p', this would also return the ;; builtin package. diff --git a/lisp/net/tramp-crypt.el b/lisp/net/tramp-crypt.el index a7af64bff5c..d44a656035d 100644 --- a/lisp/net/tramp-crypt.el +++ b/lisp/net/tramp-crypt.el @@ -117,7 +117,7 @@ initializing a new encrypted remote directory." ;; `command-completion-default-include-p'. (defun tramp-crypt-command-completion-p (symbol _buffer) "A predicate for Tramp interactive commands. -They are completed by \"M-x TAB\" only when encryption support is enabled." +They are completed by `M-x TAB' only when encryption support is enabled." (and tramp-crypt-enabled ;; `tramp-crypt-remove-directory' needs to be completed only in ;; case we have already encrypted directories. diff --git a/lisp/net/tramp-message.el b/lisp/net/tramp-message.el index b1f7aa95049..36079c8844c 100644 --- a/lisp/net/tramp-message.el +++ b/lisp/net/tramp-message.el @@ -127,7 +127,7 @@ The outline level is equal to the verbosity of the Tramp message." ;; `command-completion-default-include-p'. (defun tramp-debug-buffer-command-completion-p (_symbol buffer) "A predicate for Tramp interactive commands. -They are completed by \"M-x TAB\" only in Tramp debug buffers." +They are completed by `M-x TAB' only in Tramp debug buffers." (declare (tramp-suppress-trace t)) (with-current-buffer buffer (string-equal diff --git a/lisp/net/tramp-sh.el b/lisp/net/tramp-sh.el index bce7c323dad..4a0c09ff722 100644 --- a/lisp/net/tramp-sh.el +++ b/lisp/net/tramp-sh.el @@ -107,7 +107,7 @@ detected as prompt when being sent on echoing hosts, therefore.") (defcustom tramp-use-connection-share (not (eq system-type 'windows-nt)) "Whether to use connection share in ssh or PuTTY. -Set it to t, if you want Tramp to apply respective options. These +Set it to t, if you want Tramp to apply respective options. These are `tramp-ssh-controlmaster-options' for ssh, and \"-share\" for PuTTY. Set it to nil, if you use Control* or Proxy* options in your ssh configuration. diff --git a/lisp/net/tramp.el b/lisp/net/tramp.el index abde62d4371..e8329c82743 100644 --- a/lisp/net/tramp.el +++ b/lisp/net/tramp.el @@ -2699,7 +2699,7 @@ Run BODY." ;; `command-completion-default-include-p'. (defun tramp-command-completion-p (_symbol buffer) "A predicate for Tramp interactive commands. -They are completed by \"M-x TAB\" only if the current buffer is remote." +They are completed by `M-x TAB' only if the current buffer is remote." (tramp-tramp-file-p (tramp-get-default-directory buffer))) (defun tramp-connectable-p (vec-or-filename) commit 4c6e9f5b0046648cd01da443cab33c30666c978d Author: Stefan Kangas Date: Mon Jul 8 14:03:17 2024 +0200 Improve `use-package-vc-valid-keywords` docstring format * lisp/use-package/use-package-core.el (use-package-vc-valid-keywords): Improve docstring format. diff --git a/lisp/use-package/use-package-core.el b/lisp/use-package/use-package-core.el index bb12c3c4f2b..dd4efd3831d 100644 --- a/lisp/use-package/use-package-core.el +++ b/lisp/use-package/use-package-core.el @@ -1669,8 +1669,8 @@ Also see the Info node `(use-package) Creating an extension'." (defconst use-package-vc-valid-keywords '( :url :branch :lisp-dir :main-file :vc-backend :rev :shell-command :make :ignored-files) - "Valid keywords for the `:vc' keyword, see the Info -node `(emacs)Fetching Package Sources'.") + "Valid keywords for the `:vc' keyword. +See Info node `(emacs)Fetching Package Sources'.") (defun use-package-normalize--vc-arg (arg) "Normalize possible arguments to the `:vc' keyword. commit 928180f32be15a33c0848b81aba0b4d01f7d54e3 Author: Stefan Kangas Date: Mon Jul 8 13:52:42 2024 +0200 ; * etc/TODO: New item on installing Magit. diff --git a/etc/TODO b/etc/TODO index 40571b9de3c..53b456c733a 100644 --- a/etc/TODO +++ b/etc/TODO @@ -727,10 +727,17 @@ bar. In the mean time, it should process other messages. ** Get some major packages installed +*** Magit +This needs work on getting the relevant copyright assignments. This +task should be highly doable for anyone, but will likely require some +patience. For inspiration, see how this was done for 'use-package': +https://github.com/jwiegley/use-package/issues/282 + *** PSGML, _possibly_ ECB https://lists.gnu.org/r/emacs-devel/2007-05/msg01493.html Check the assignments file for other packages which might go in and have been -missed. +missed. (Not sure if this is still relevant in 2024. For example, both +packages seem to be unmaintained.) ** Make byte-compiler warnings smarter Byte-compiler warnings about functions that might be undefined at run commit c193a702dc21b1f106dd2d0dd0bf52e1973bf9c9 Author: Eli Zaretskii Date: Mon Jul 8 14:48:25 2024 +0300 ; Improve a recent change to the documentation * lisp/emacs-lisp/comp.el (native-comp-debug): * doc/lispref/compile.texi (Native-Compilation Variables): Improve wording. diff --git a/doc/lispref/compile.texi b/doc/lispref/compile.texi index 6ca97e0dc4f..65442dd8d19 100644 --- a/doc/lispref/compile.texi +++ b/doc/lispref/compile.texi @@ -1025,8 +1025,8 @@ Like 2, and in addition dump the GCC intermediate passes and @file{libgccjit} log file. @end table -When generated the pseudo C code is deposed in the .eln output -directory. +When generated, the pseudo-C code is deposited in the same directory +as the corresponding @file{.eln} file. @end defopt @defopt native-comp-verbose diff --git a/lisp/emacs-lisp/comp.el b/lisp/emacs-lisp/comp.el index 15079903a03..947fb06e602 100644 --- a/lisp/emacs-lisp/comp.el +++ b/lisp/emacs-lisp/comp.el @@ -76,8 +76,8 @@ This is intended for debugging the compiler itself. 2 emit debug symbols and dump pseudo C code. 3 emit debug symbols and dump: pseudo C code, GCC intermediate passes and libgccjit log file. -When generated the pseudo C code is deposed in the .eln output -directory." +When generated, the pseudo C code is deposited in the same directory +as the corresponding .eln file." :type 'natnum :safe #'natnump :version "29.1") commit 6ebc5d5c27854a7041014fdb7b248b873379befc Author: Stefan Kangas Date: Mon Jul 8 12:45:30 2024 +0200 ; Delete fixed item from etc/TODO: "proced on macOS" The 'process-attributes' function is supported since Emacs 26.1, and proced seems to be fully working. * etc/TODO: Delete fixed item: "proced on macOS". diff --git a/etc/TODO b/etc/TODO index a6964c67fc2..40571b9de3c 100644 --- a/etc/TODO +++ b/etc/TODO @@ -953,25 +953,6 @@ the tool bar is performed. Unfortunately, the tool bar (and possible other operations) always resize the frame. -**** Support 'proced' (implement 'process-attributes') -Unfortunately, a user-level process like Emacs does not have the -privileges to get information about other processes under macOS. - -There are other ways to do this: - - 1) Spawn "ps" and parse the output ("ps" has superuser privileges). - - 2) Sign Emacs as part of the distribution process. - - 3) Ask the user to self-sign Emacs, if this feature is of interest. - -Anders Lindgren has implemented -'process-attributes' for macOS, which currently only work when -running Emacs as root. - -See this article by Bozhidar Batsov for an overview of Proced: -https://emacsredux.com/blog/2013/05/02/manage-processes-with-proced/ - **** Tooltip properties Tooltip properties like the background color and font are hard-wired, even though Emacs allows a user to customize such features. commit 7b2778e3a3d37debb244971611687dc7f68091d5 Author: Stefan Kangas Date: Mon Jul 8 12:38:29 2024 +0200 ; Delete fixed NS bug from etc/TODO * etc/TODO: Delete fixed NS bug with 'mouse-avoidance-mode'. Ref: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=17439#43 diff --git a/etc/TODO b/etc/TODO index 78e88c99397..a6964c67fc2 100644 --- a/etc/TODO +++ b/etc/TODO @@ -1113,10 +1113,6 @@ corner and track mouse movements, but this did not work well, and was not scalable to the new Lion "resize on every window edge" behavior. [As of trunk r109635, 2012-08-15, the event loop no longer polls.] -**** mouse-avoidance-mode -(mouse-avoidance-mode 'banish) then minimize Emacs, will pop window back -up on top of all others (probably fixed in bug#17439). - **** free_frame_resources, face colors **** Numeric keysetting bug. commit 84552ff395c133bebfa4b542485317236230f1f5 Author: Stefan Kangas Date: Mon Jul 8 12:15:05 2024 +0200 Revert "Fix link to major mode variable in docstring" This reverts commit 73c1252bb6b7cc61d9f992818568d3c57de4ff67. This will sometimes say "the variable `(default-value 'global-auto-revert-mode)'". Problem reported by Eshel Yaron . diff --git a/lisp/emacs-lisp/easy-mmode.el b/lisp/emacs-lisp/easy-mmode.el index 7006ae6c785..944a74a91ee 100644 --- a/lisp/emacs-lisp/easy-mmode.el +++ b/lisp/emacs-lisp/easy-mmode.el @@ -91,7 +91,7 @@ Enable the mode if ARG is nil, omitted, or is a positive number. Disable the mode if ARG is a negative number. To check whether the minor mode is enabled in the current buffer, -evaluate the variable `%s'. +evaluate `%s'. The mode's hook is called both when the mode is enabled and when it is disabled.") commit 198063ba643ae42ba3464317af38abcaf1fac550 Author: Stefan Kangas Date: Sun Jul 7 22:32:20 2024 +0200 * etc/TODO: Add item to convert documentation to 'setopt'. diff --git a/etc/TODO b/etc/TODO index 2750e3c114d..78e88c99397 100644 --- a/etc/TODO +++ b/etc/TODO @@ -88,6 +88,15 @@ outside of the mode they were written for. Verify the conversion by comparing the value of the keymap before converting it and after (you can see the value in 'C-h v'). +** Change documentation examples to use 'setopt' instead of 'setq' +User options are variables defined with 'defcustom', as opposed to +'defvar' or 'defconst'. It is preferable to use 'setopt' to set user +options instead of 'setq', since it will execute any ‘custom-set’ form +associated with that variable. Pick a package and make sure that it +uses 'setopt' in any examples in its documentation (doc strings, manual, +Commentary section, etc.). Note that 'setopt' is new in Emacs 29.1, so +packages that need support for earlier versions should still use 'setq'. + ** Write more tests Pick a fixed bug from the database, write a test case to make sure it stays fixed. Or pick your favorite programming major-mode, and write commit 92de67829ca18b4957cb995a1442f2ccac80847c Author: Stefan Kangas Date: Sun Jul 7 21:38:10 2024 +0200 Prefer 'setopt' in browse-url docs * lisp/net/browse-url.el: (browse-url-filename-alist): Doc fix; prefer 'setopt'. diff --git a/lisp/net/browse-url.el b/lisp/net/browse-url.el index f22aa19f5e3..3048b8f6c22 100644 --- a/lisp/net/browse-url.el +++ b/lisp/net/browse-url.el @@ -113,10 +113,10 @@ ;; Use the Emacs Web Wowser (EWW) when not running under X11: ;; (or (eq window-system 'x) -;; (setq browse-url-browser-function #'eww-browse-url)) +;; (setopt browse-url-browser-function #'eww-browse-url)) ;; To always save modified buffers before displaying the file in a browser: -;; (setq browse-url-save-file t) +;; (setopt browse-url-save-file t) ;; To invoke different browsers/tools for different URLs, customize ;; `browse-url-handlers'. In earlier versions of Emacs, the same @@ -419,14 +419,14 @@ value converts ange-ftp-style file names into ftp URLs and prepends `file:' to any file name beginning with `/'. For example, adding to the default a specific translation of an ange-ftp -address to an HTTP URL: - - (setq browse-url-filename-alist - \\='((\"/webmaster@webserver:/home/www/html/\" . - \"https://www.example.org/\") - (\"^/\\(ftp@\\|anonymous@\\)?\\([^:/]+\\):/*\" . \"ftp://\\2/\") - (\"^/\\([^:@/]+@\\)?\\([^:/]+\\):/*\" . \"ftp://\\1\\2/\") - (\"^/+\" . \"file:/\")))" +address to an HTTPS URL: + + (setopt browse-url-filename-alist + \\='((\"/webmaster@webserver:/home/www/html/\" . + \"https://www.example.org/\") + (\"^/\\(ftp@\\|anonymous@\\)?\\([^:/]+\\):/*\" . \"ftp://\\2/\") + (\"^/\\([^:@/]+@\\)?\\([^:/]+\\):/*\" . \"ftp://\\1\\2/\") + (\"^/+\" . \"file:/\")))" :type '(repeat (cons :format "%v" (regexp :tag "Regexp") (string :tag "Replacement"))) commit 76683853905e73c3f40151f28a8ac7772f2dcec3 Author: Andrea Corallo Date: Mon Jul 8 11:05:29 2024 +0200 ; Improve 'native-comp-debug' documentation * lisp/emacs-lisp/comp.el (native-comp-debug): Improve doc. * doc/lispref/compile.texi (Native-Compilation Variables): Likewise. diff --git a/doc/lispref/compile.texi b/doc/lispref/compile.texi index 9f93fb4a981..6ca97e0dc4f 100644 --- a/doc/lispref/compile.texi +++ b/doc/lispref/compile.texi @@ -1024,6 +1024,9 @@ Like 1, and in addition dump pseudo-C code. Like 2, and in addition dump the GCC intermediate passes and @file{libgccjit} log file. @end table + +When generated the pseudo C code is deposed in the .eln output +directory. @end defopt @defopt native-comp-verbose diff --git a/lisp/emacs-lisp/comp.el b/lisp/emacs-lisp/comp.el index 2844e89c661..15079903a03 100644 --- a/lisp/emacs-lisp/comp.el +++ b/lisp/emacs-lisp/comp.el @@ -75,7 +75,9 @@ This is intended for debugging the compiler itself. 1 emit debug symbols. 2 emit debug symbols and dump pseudo C code. 3 emit debug symbols and dump: pseudo C code, GCC intermediate - passes and libgccjit log file." + passes and libgccjit log file. +When generated the pseudo C code is deposed in the .eln output +directory." :type 'natnum :safe #'natnump :version "29.1") commit ce56f939affe8147f4172aa030058029a3c7922b Merge: 8e1a43890da 67f291ddae3 Author: Po Lu Date: Mon Jul 8 15:43:55 2024 +0800 Merge from savannah/emacs-30 67f291ddae3 Correct conditions for iconification on Android 130c3efa108 Fix execution of MS-Windows app execution aliases in Eshell fffab032b05 Improve 'tab-line-tabs-fixed-window-buffers' sorting perf... commit 8e1a43890da53a387c31950f11c3d2dbb7a70614 Merge: df1630ad3b8 069fa639097 Author: Po Lu Date: Mon Jul 8 15:43:55 2024 +0800 ; Merge from savannah/emacs-30 The following commit was skipped: 069fa639097 Adapt Tramp version (don't merge) commit df1630ad3b85538b86f054073364c9ba0c989909 Merge: 4d21dff5714 f4c0459ed3e Author: Po Lu Date: Mon Jul 8 15:43:55 2024 +0800 Merge from savannah/emacs-30 f4c0459ed3e Fix Tramp parser 47c79b62dd0 Checkdoc fixes in progmodes 6757f8e67d3 Checkdoc fixes in Org Mode 9fcee3c1d1e Clarify `checkdoc-max-keyref-before-warn` docstring b249f022f12 * lisp/files.el (insert-directory): Quote switches in wil... 8911d53ce5d Fix uses of 'dired-omit-mode' (bug#71905) commit 67f291ddae31cc4623fd93280b141ee8611f3f5a Author: Po Lu Date: Mon Jul 8 15:33:26 2024 +0800 Correct conditions for iconification on Android * java/org/gnu/emacs/EmacsActivity.java (EmacsActivity) : Rename to . (attachWindow): Adjust to match. (onPause): Delete function. (onStop): Deem frames iconified after calls to onStop instead. diff --git a/java/org/gnu/emacs/EmacsActivity.java b/java/org/gnu/emacs/EmacsActivity.java index 7d02e4f4834..0c9e8312b90 100644 --- a/java/org/gnu/emacs/EmacsActivity.java +++ b/java/org/gnu/emacs/EmacsActivity.java @@ -78,7 +78,7 @@ public class EmacsActivity extends Activity public static EmacsWindow focusedWindow; /* Whether or not this activity is paused. */ - private boolean isPaused; + private boolean isStopped; /* Whether or not this activity is fullscreen. */ private boolean isFullscreen; @@ -196,7 +196,7 @@ children and RESETWHENCHILDLESS is set (implying it is a window.view.requestFocus (); /* If the activity is iconified, send that to the window. */ - if (isPaused) + if (isStopped) window.noticeIconified (); /* Invalidate the focus. Since attachWindow may be called from @@ -308,8 +308,13 @@ children and RESETWHENCHILDLESS is set (implying it is a public final void onStop () { - timeOfLastInteraction = SystemClock.elapsedRealtime (); + /* Iconification was previously reported in onPause, but that was + misinformed, as `onStop' is the actual callback activated upon + changes in an activity's visibility. */ + isStopped = true; + EmacsWindowManager.MANAGER.noticeIconified (this); + timeOfLastInteraction = SystemClock.elapsedRealtime (); super.onStop (); } @@ -403,21 +408,11 @@ children and RESETWHENCHILDLESS is set (implying it is a invalidateFocus (3); } - @Override - public final void - onPause () - { - isPaused = true; - - EmacsWindowManager.MANAGER.noticeIconified (this); - super.onPause (); - } - @Override public final void onResume () { - isPaused = false; + isStopped = false; timeOfLastInteraction = 0; EmacsWindowManager.MANAGER.noticeDeiconified (this); commit 130c3efa108de4db0a4a8b7521ecf6551efa89cb Author: Jim Porter Date: Sat Jun 22 12:45:19 2024 -0700 Fix execution of MS-Windows app execution aliases in Eshell * lisp/eshell/esh-ext.el (eshell-script-interpreter): Check for 0-size files (bug#71655). diff --git a/lisp/eshell/esh-ext.el b/lisp/eshell/esh-ext.el index 3c4deb32601..cf93d2904da 100644 --- a/lisp/eshell/esh-ext.el +++ b/lisp/eshell/esh-ext.el @@ -301,7 +301,17 @@ Return nil, or a list of the form: (INTERPRETER [ARGS] FILE)" (let ((maxlen eshell-command-interpreter-max-length)) (if (and (file-readable-p file) - (file-regular-p file)) + (file-regular-p file) + ;; If the file is zero bytes, it can't possibly have a + ;; shebang. This check may seem redundant, but we can + ;; encounter files that Emacs considers both readable and + ;; regular, but which aren't *actually* readable. This can + ;; happen, for example, with certain kinds of reparse + ;; points like APPEXECLINK on NTFS filesystems (MS-Windows + ;; uses these for "app execution aliases"). In these + ;; cases, the file size is 0, so this check protects us + ;; from errors. + (> (file-attribute-size (file-attributes file)) 0)) (with-temp-buffer (insert-file-contents-literally file nil 0 maxlen) (if (looking-at "#![ \t]*\\([^ \r\t\n]+\\)\\([ \t]+\\(.+\\)\\)?") commit fffab032b05d5dcb72d6729321739ca814c54a28 Author: Eval EXEC Date: Fri Jul 5 18:53:36 2024 +0800 Improve 'tab-line-tabs-fixed-window-buffers' sorting performance * lsp/tab-line.el (tab-line-tabs-fixed-window-buffers): Enhance 'tab-line-tabs-fixed-window-buffers' performance by optimizing buffer sorting mechanism. Replace inefficient 'seq-position' calls with a hash table to cache buffer positions, significantly improving speed when handling large buffer lists (bug#71958). Copyright-paperwork-exempt: yes diff --git a/lisp/tab-line.el b/lisp/tab-line.el index 1d14fda9825..462a0a27692 100644 --- a/lisp/tab-line.el +++ b/lisp/tab-line.el @@ -555,10 +555,15 @@ This means that switching to a buffer previously shown in the same window will keep the same order of tabs that was before switching. And newly displayed buffers are added to the end of the tab line." (let* ((old-buffers (window-parameter nil 'tab-line-buffers)) + (buffer-positions (let ((index-table (make-hash-table :test 'eq))) + (seq-do-indexed + (lambda (buf idx) (puthash buf idx index-table)) + old-buffers) + index-table)) (new-buffers (sort (tab-line-tabs-window-buffers) :key (lambda (buffer) - (or (seq-position old-buffers buffer) - most-positive-fixnum))))) + (gethash buffer buffer-positions + most-positive-fixnum))))) (set-window-parameter nil 'tab-line-buffers new-buffers) new-buffers)) commit 069fa6390973bde3a1c551369ed54d741f369703 Author: Michael Albinus Date: Sun Jul 7 19:35:06 2024 +0200 Adapt Tramp version (don't merge) * doc/misc/trampver.texi: * lisp/net/trampver.el (tramp-version): Adapt Tramp versions. diff --git a/doc/misc/trampver.texi b/doc/misc/trampver.texi index 521fe592e74..1a20ac1a2fe 100644 --- a/doc/misc/trampver.texi +++ b/doc/misc/trampver.texi @@ -7,7 +7,7 @@ @c In the Tramp GIT, the version number and the bug report address @c are auto-frobbed from configure.ac. -@set trampver 2.7.1 +@set trampver 2.7.1.30.1 @set trampurl https://www.gnu.org/software/tramp/ @set tramp-bug-report-address tramp-devel@@gnu.org @set emacsver 27.1 diff --git a/lisp/net/trampver.el b/lisp/net/trampver.el index 8bbfddeaab3..d746aa55f45 100644 --- a/lisp/net/trampver.el +++ b/lisp/net/trampver.el @@ -7,7 +7,7 @@ ;; Maintainer: Michael Albinus ;; Keywords: comm, processes ;; Package: tramp -;; Version: 2.7.1 +;; Version: 2.7.1.30.1 ;; Package-Requires: ((emacs "27.1")) ;; Package-Type: multi ;; URL: https://www.gnu.org/software/tramp/ @@ -40,7 +40,7 @@ ;; ./configure" to change them. ;;;###tramp-autoload -(defconst tramp-version "2.7.1" +(defconst tramp-version "2.7.1.30.1" "This version of Tramp.") ;;;###tramp-autoload @@ -78,7 +78,7 @@ ;; Check for Emacs version. (let ((x (if (not (string-version-lessp emacs-version "27.1")) "ok" - (format "Tramp 2.7.1 is not fit for %s" + (format "Tramp 2.7.1.30.1 is not fit for %s" (replace-regexp-in-string "\n" "" (emacs-version)))))) (unless (string-equal "ok" x) (error "%s" x))) @@ -107,7 +107,7 @@ ("2.5.2.28.1" . "28.1") ("2.5.3.28.2" . "28.2") ("2.5.4" . "28.3") ("2.6.0.29.1" . "29.1") ("2.6.2.29.2" . "29.2") ("2.6.3-pre" . "29.3") ("2.6.3" . "29.4") - ("2.7.1" . "30.1"))) + ("2.7.1.30.1" . "30.1"))) (add-hook 'tramp-unload-hook (lambda () commit f4c0459ed3edce33329744f60a0e389c20dc60a5 Author: Michael Albinus Date: Sun Jul 7 19:34:37 2024 +0200 Fix Tramp parser * lisp/net/tramp.el (tramp-host-with-port-regexp): Declare. (tramp-set-syntax): Set also `tramp-host-with-port-regexp'. (tramp-build-host-with-port-regexp): New defun. (tramp-host-with-port-regexp): Make it a defvar. (Bug#71972) * test/lisp/net/tramp-tests.el (tramp-test01-file-name-syntax) (tramp-test01-file-name-syntax-simplified) (tramp-test01-file-name-syntax-separate): Adapt tests. diff --git a/lisp/net/tramp.el b/lisp/net/tramp.el index f97ed66c58b..abde62d4371 100644 --- a/lisp/net/tramp.el +++ b/lisp/net/tramp.el @@ -78,6 +78,7 @@ (defvar tramp-postfix-ipv6-regexp) (defvar tramp-postfix-host-format) (defvar tramp-postfix-host-regexp) +(defvar tramp-host-with-port-regexp) (defvar tramp-remote-file-name-spec-regexp) (defvar tramp-file-name-structure) (defvar tramp-file-name-regexp) @@ -878,6 +879,7 @@ to be set, depending on VALUE." tramp-postfix-ipv6-regexp (tramp-build-postfix-ipv6-regexp) tramp-postfix-host-format (tramp-build-postfix-host-format) tramp-postfix-host-regexp (tramp-build-postfix-host-regexp) + tramp-host-with-port-regexp (tramp-build-host-with-port-regexp) tramp-remote-file-name-spec-regexp (tramp-build-remote-file-name-spec-regexp) tramp-file-name-structure (tramp-build-file-name-structure) @@ -955,7 +957,8 @@ The `ftp' syntax does not support methods.") "Return `tramp-postfix-method-format' according to `tramp-syntax'." (tramp-lookup-syntax tramp-postfix-method-format-alist)) -(defvar tramp-postfix-method-format nil ; Init'd when defining `tramp-syntax'! +(defvar tramp-postfix-method-format + nil ; Initialized when defining `tramp-syntax'! "String matching delimiter between method and user or host names. The `ftp' syntax does not support methods. Used in `tramp-make-tramp-file-name'.") @@ -964,7 +967,8 @@ Used in `tramp-make-tramp-file-name'.") "Return `tramp-postfix-method-regexp'." (rx (literal (tramp-build-postfix-method-format)))) -(defvar tramp-postfix-method-regexp nil ; Init'd when defining `tramp-syntax'! +(defvar tramp-postfix-method-regexp + nil ; Initialized when defining `tramp-syntax'! "Regexp matching delimiter between method and user or host names. Derived from `tramp-postfix-method-format'.") @@ -1059,11 +1063,18 @@ Derived from `tramp-prefix-port-format'.") (defconst tramp-port-regexp (rx (+ digit)) "Regexp matching port numbers.") -(defconst tramp-host-with-port-regexp +(defun tramp-build-host-with-port-regexp () + "Return `tramp-host-with-port-regexp'." (rx - (group (regexp tramp-host-regexp)) + (group (| (regexp tramp-host-regexp) + (: (regexp tramp-prefix-ipv6-regexp) + (? (regexp tramp-ipv6-regexp)) + (regexp tramp-postfix-ipv6-regexp)))) (regexp tramp-prefix-port-regexp) - (group (regexp tramp-port-regexp))) + (group (regexp tramp-port-regexp)))) + +(defvar tramp-host-with-port-regexp + nil ; Initialized when defining `tramp-syntax'! "Regexp matching host names with port numbers.") (defconst tramp-postfix-hop-format "|" diff --git a/test/lisp/net/tramp-tests.el b/test/lisp/net/tramp-tests.el index bf77179e039..8074bed7a47 100644 --- a/test/lisp/net/tramp-tests.el +++ b/test/lisp/net/tramp-tests.el @@ -330,6 +330,10 @@ is greater than 10. (should (tramp-tramp-file-p "/method:1.2.3.4:")) (should (tramp-tramp-file-p "/method:user@1.2.3.4:")) + ;; Using an IPv4 address with port. + (should (tramp-tramp-file-p "/method:1.2.3.4#1234:")) + (should (tramp-tramp-file-p "/method:user@1.2.3.4#1234:")) + ;; Using an IPv6 address. (should (tramp-tramp-file-p "/method:[::1]:")) (should (tramp-tramp-file-p "/method:user@[::1]:")) @@ -338,6 +342,10 @@ is greater than 10. (should (tramp-tramp-file-p "/method:[::ffff:1.2.3.4]:")) (should (tramp-tramp-file-p "/method:user@[::ffff:1.2.3.4]:")) + ;; Using an IPv6 address with port. + (should (tramp-tramp-file-p "/method:[::1]#1234:")) + (should (tramp-tramp-file-p "/method:user@[::1]#1234:")) + ;; Local file name part. (should (tramp-tramp-file-p "/method:::")) (should (tramp-tramp-file-p "/method::/:")) @@ -418,6 +426,10 @@ is greater than 10. (should (tramp-tramp-file-p "/1.2.3.4:")) (should (tramp-tramp-file-p "/user@1.2.3.4:")) + ;; Using an IPv4 address with port. + (should (tramp-tramp-file-p "/1.2.3.4#1234:")) + (should (tramp-tramp-file-p "/user@1.2.3.4#1234:")) + ;; Using an IPv6 address. (should (tramp-tramp-file-p "/[::1]:")) (should (tramp-tramp-file-p "/user@[::1]:")) @@ -426,6 +438,10 @@ is greater than 10. (should (tramp-tramp-file-p "/[::ffff:1.2.3.4]:")) (should (tramp-tramp-file-p "/user@[::ffff:1.2.3.4]:")) + ;; Using an IPv6 address with port. + (should (tramp-tramp-file-p "/[::1]#1234:")) + (should (tramp-tramp-file-p "/user@[::1]#1234:")) + ;; Local file name part. (should (tramp-tramp-file-p "/host::")) (should (tramp-tramp-file-p "/host:/:")) @@ -472,6 +488,10 @@ is greater than 10. (should (tramp-tramp-file-p "/[method/1.2.3.4]")) (should (tramp-tramp-file-p "/[method/user@1.2.3.4]")) + ;; Using an IPv4 address with port. + (should (tramp-tramp-file-p "/[method/1.2.3.4#1234]")) + (should (tramp-tramp-file-p "/[method/user@1.2.3.4#1234]")) + ;; Using an IPv6 address. (should (tramp-tramp-file-p "/[method/::1]")) (should (tramp-tramp-file-p "/[method/user@::1]")) @@ -480,6 +500,10 @@ is greater than 10. (should (tramp-tramp-file-p "/[method/::ffff:1.2.3.4]")) (should (tramp-tramp-file-p "/[method/user@::ffff:1.2.3.4]")) + ;; Using an IPv6 address with port. + (should (tramp-tramp-file-p "/[method/::1#1234]")) + (should (tramp-tramp-file-p "/[method/user@::1#1234]")) + ;; Local file name part. (should (tramp-tramp-file-p "/[method/]")) (should (tramp-tramp-file-p "/[method/]/:")) commit 47c79b62dd04e9ec585354b35e0ef3b3e8c2878d Author: Stefan Kangas Date: Sun Jul 7 14:50:18 2024 +0200 Checkdoc fixes in progmodes * lisp/progmodes/cperl-mode.el (cperl-file-style) (cperl-continued-brace-offset, cperl-tips-faces): * lisp/progmodes/eglot.el (eglot-confirm-server-edits, eglot) (eglot-list-connections-mode, eglot--outstanding-inlay-hints-region) (eglot--outstanding-inlay-regions-timer): * lisp/progmodes/etags.el (etags-goto-tag-location) (etags--xref-apropos-additional): * lisp/progmodes/flymake.el (flymake-autoresize-margins): * lisp/progmodes/gdb-mi.el (gdb-mouse-until, gdb-mouse-jump): * lisp/progmodes/hideif.el (hif-parse-macro-arglist): * lisp/progmodes/idlw-help.el (idlwave-html-help-location): * lisp/progmodes/idlwave.el (idlwave-reserved-word-upcase): * lisp/progmodes/java-ts-mode.el (java-ts-mode--string-highlight-helper): * lisp/progmodes/js.el (js--chained-expression-p): * lisp/progmodes/pascal.el (pascal-mode, pascal-comment-area): * lisp/progmodes/python.el (python--treesit-fontify-union-types): * lisp/progmodes/ruby-mode.el (ruby-align-chained-calls) (ruby-block-indent, ruby-rubocop-use-bundler): * lisp/progmodes/rust-ts-mode.el (rust-ts-mode--prettify-symbols-compose-p): * lisp/progmodes/verilog-mode.el (verilog-cache-has-lisp) (verilog-auto-insert-lisp, verilog-highlight-region): * lisp/progmodes/xref.el (xref--get-history): Various checkdoc fixes. diff --git a/lisp/progmodes/cperl-mode.el b/lisp/progmodes/cperl-mode.el index 68ad7eda9a7..217125e1599 100644 --- a/lisp/progmodes/cperl-mode.el +++ b/lisp/progmodes/cperl-mode.el @@ -161,13 +161,13 @@ for constructs with multiline if/unless/while/until/for/foreach condition." :group 'cperl-autoinsert-details) (defcustom cperl-file-style nil - "Indentation style to use in cperl-mode. + "Indentation style to use in `cperl-mode'. Setting this option will override options as given in `cperl-style-alist' for the keyword provided here. If nil, then the individual options as customized are used. \"PBP\" is the style recommended in the Book \"Perl Best Practices\" by Damian Conway. \"CPerl\" is the traditional style -of cperl-mode, and \"PerlStyle\" follows the Perl documentation +of `cperl-mode', and \"PerlStyle\" follows the Perl documentation in perlstyle. The other styles have been developed for other programming languages, mostly C." :type '(choice (const "PBP") @@ -232,7 +232,7 @@ to the right of the start of its line." :group 'cperl-indentation-details) (defcustom cperl-continued-brace-offset 0 "Extra indent for substatements that start with open-braces. -This is in addition to cperl-continued-statement-offset." +This is in addition to `cperl-continued-statement-offset'." :type 'integer :group 'cperl-indentation-details) (defcustom cperl-close-paren-offset -1 @@ -819,7 +819,7 @@ B) Speed of editing operations. of, say, long POD sections.") (defvar cperl-tips-faces 'please-ignore-this-line - "CPerl mode uses following faces for highlighting: + "CPerl mode uses the following faces for highlighting: `cperl-array-face' Array names `cperl-hash-face' Hash names diff --git a/lisp/progmodes/eglot.el b/lisp/progmodes/eglot.el index 574e8571cc8..5845aff39b7 100644 --- a/lisp/progmodes/eglot.el +++ b/lisp/progmodes/eglot.el @@ -494,7 +494,7 @@ If this variable's value can also be an alist ((COMMAND . ACTION) ...) where COMMAND is a symbol designating a command, such as `eglot-rename', `eglot-code-actions', `eglot-code-action-quickfix', etc. ACTION is one of the symbols -described above. The value `t' for COMMAND is accepted and its +described above. The value t for COMMAND is accepted and its ACTION is the default value for commands not in the alist." :type (let ((basic-choices '((const :tag "Use diff" diff) @@ -1415,7 +1415,7 @@ INTERACTIVE is ignored and provided for backward compatibility." (unless (or (null current-server) (y-or-n-p "\ [eglot] Shut down current connection before attempting new one?")) - (user-error "[eglot] Connection attempt aborted by user.")) + (user-error "[eglot] Connection attempt aborted by user")) (prog1 (append (eglot--guess-contact t) '(t)) (when current-server (ignore-errors (eglot-shutdown current-server)))))) (eglot--connect (eglot--ensure-list managed-major-modes) @@ -3935,7 +3935,7 @@ If NOERROR, return predicate, else erroring function." ;;; List connections mode (define-derived-mode eglot-list-connections-mode tabulated-list-mode - "" "Eglot mode for listing server connections + "" "Eglot mode for listing server connections. \\{eglot-list-connections-mode-map}" :interactive nil (setq-local tabulated-list-format @@ -3977,12 +3977,12 @@ If NOERROR, return predicate, else erroring function." "Face used for parameter inlay hint overlays.") (defvar-local eglot--outstanding-inlay-hints-region (cons nil nil) - "Jit-lock-calculated (FROM . TO) region with potentially outdated hints") + "Jit-lock-calculated (FROM . TO) region with potentially outdated hints.") (defvar-local eglot--outstanding-inlay-hints-last-region nil) (defvar-local eglot--outstanding-inlay-regions-timer nil - "Helper timer for `eglot--update-hints'") + "Helper timer for `eglot--update-hints'.") (defun eglot--update-hints (from to) "Jit-lock function for Eglot inlay hints." diff --git a/lisp/progmodes/etags.el b/lisp/progmodes/etags.el index 597612196fd..d3eb0d46e9b 100644 --- a/lisp/progmodes/etags.el +++ b/lisp/progmodes/etags.el @@ -1364,7 +1364,7 @@ hits the start of file." (cond (line (progn (goto-char (point-min)) (forward-line (1- line)))) (startpos (goto-char startpos)) - (t (error "etags.el BUG: bogus direct file tag"))) + (t (error "etags.el: BUG: bogus direct file tag"))) ;; This constant is 1/2 the initial search window. ;; There is no sense in making it too small, ;; since just going around the loop once probably @@ -2182,7 +2182,7 @@ file name, add `tag-partial-file-name-match-p' to the list value.") (when (symbolp symbs) (if (boundp symbs) (setq symbs (symbol-value symbs)) - (warn "symbol `%s' has no value" symbs) + (warn "Symbol `%s' has no value" symbs) (setq symbs nil)) (if (obarrayp symbs) (mapatoms add-xref symbs) diff --git a/lisp/progmodes/flymake.el b/lisp/progmodes/flymake.el index 6301b77beca..e72f25fd0cd 100644 --- a/lisp/progmodes/flymake.el +++ b/lisp/progmodes/flymake.el @@ -218,7 +218,7 @@ this is used." (face :tag "Face")))) (defcustom flymake-autoresize-margins t - "If non-nil, automatically resize margin-width calling flymake--resize-margins. + "If non-nil, automatically resize margin-width calling `flymake--resize-margins'. Only relevant if `flymake-indicator-type' is set to margins." :version "30.1" diff --git a/lisp/progmodes/gdb-mi.el b/lisp/progmodes/gdb-mi.el index 0ce5e1df794..2981965ee0c 100644 --- a/lisp/progmodes/gdb-mi.el +++ b/lisp/progmodes/gdb-mi.el @@ -1285,8 +1285,8 @@ no input, and GDB is waiting for input." (defun gdb-mouse-until (event) "Continue running until a source line past the current line. The destination source line can be selected either by clicking -with mouse-3 on the fringe/margin or dragging the arrow -with mouse-1 (default bindings)." +with \\`mouse-3' on the fringe/margin or dragging the arrow +with \\`mouse-1' (default bindings)." (interactive "e") (let ((start (event-start event)) (end (event-end event))) @@ -1302,8 +1302,8 @@ with mouse-1 (default bindings)." (defun gdb-mouse-jump (event) "Set execution address/line. -The destination source line can be selected either by clicking with C-mouse-3 -on the fringe/margin or dragging the arrow with C-mouse-1 (default bindings). +The destination source line can be selected either by clicking with \\`C-mouse-3' +on the fringe/margin or dragging the arrow with \\`C-mouse-1' (default bindings). Unlike `gdb-mouse-until' the destination address can be before the current line, and no execution takes place." (interactive "e") diff --git a/lisp/progmodes/hideif.el b/lisp/progmodes/hideif.el index 98e567299a1..9bcac0d8dc5 100644 --- a/lisp/progmodes/hideif.el +++ b/lisp/progmodes/hideif.el @@ -2407,7 +2407,7 @@ first arg will be `hif-etc'." 'c99 t))) ((eq token 'hif-comma) (if etc - (error "Syntax error: no comma allowed after `...'."))) + (error "Syntax error: no comma allowed after `...'"))) (t (push token result)))) (setq result (nreverse result)) diff --git a/lisp/progmodes/idlw-help.el b/lisp/progmodes/idlw-help.el index 7bed69a738b..c311e1c5377 100644 --- a/lisp/progmodes/idlw-help.el +++ b/lisp/progmodes/idlw-help.el @@ -62,8 +62,8 @@ is used in preference to the old `idlwave-html-help-location'." (if (memq system-type '(ms-dos windows-nt)) nil "/usr/local/etc/") - "The directory where the idl_html_help/ dir lives. Obsolete for IDL -6.2 or later (see `idlwave-html-system-help-location')." + "The directory where the idl_html_help/ dir lives. +Obsolete for IDL 6.2 or later (see `idlwave-html-system-help-location')." :type 'directory) (defcustom idlwave-help-use-assistant t diff --git a/lisp/progmodes/idlwave.el b/lisp/progmodes/idlwave.el index 30442fa0d34..b3e9eb58196 100644 --- a/lisp/progmodes/idlwave.el +++ b/lisp/progmodes/idlwave.el @@ -798,7 +798,7 @@ upper case, regardless of this variable." (defcustom idlwave-reserved-word-upcase nil "Non-nil means, reserved words will be made upper case via abbrev expansion. If nil case of reserved words is controlled by `idlwave-abbrev-change-case'. -Has effect only if in abbrev-mode." +Has effect only if in `abbrev-mode'." :group 'idlwave-abbrev-and-indent-action :type 'boolean) diff --git a/lisp/progmodes/java-ts-mode.el b/lisp/progmodes/java-ts-mode.el index bb4a7df3340..4ceb211ade1 100644 --- a/lisp/progmodes/java-ts-mode.el +++ b/lisp/progmodes/java-ts-mode.el @@ -155,8 +155,8 @@ "Java operators for tree-sitter font-locking.") (defun java-ts-mode--string-highlight-helper () -"Returns, for strings, a query based on what is supported by -the available version of Tree-sitter for java." + "Return, for strings, a query based on what is supported by +the available version of Tree-sitter for Java." (condition-case nil (progn (treesit-query-capture 'java '((text_block) @font-lock-string-face)) `((string_literal) @font-lock-string-face diff --git a/lisp/progmodes/js.el b/lisp/progmodes/js.el index 31e8f2924ac..f8140c14a49 100644 --- a/lisp/progmodes/js.el +++ b/lisp/progmodes/js.el @@ -2493,7 +2493,7 @@ Returns t if successful, nil if no term was found." t))) (defun js--chained-expression-p () - "A helper for js--proper-indentation that handles chained expressions. + "Helper for `js--proper-indentation' that handles chained expressions. A chained expression is when the current line starts with '.' and the previous line also has a '.' expression. This function returns the indentation for the current line if it is diff --git a/lisp/progmodes/pascal.el b/lisp/progmodes/pascal.el index bd39b64aefc..802c02dcfa4 100644 --- a/lisp/progmodes/pascal.el +++ b/lisp/progmodes/pascal.el @@ -297,7 +297,8 @@ are handled in another way, and should not be added to this list." ;;;###autoload (define-derived-mode pascal-mode prog-mode "Pascal" - "Major mode for editing Pascal code.\\ + "Major mode for editing Pascal code. +\\ TAB indents for Pascal code. Delete converts tabs to spaces as it moves back. \\[completion-at-point] completes the word around current point with respect \ @@ -333,7 +334,7 @@ Variables controlling indentation/edit style: regardless of where in the line point is when the TAB command is used. `pascal-auto-endcomments' (default t) Non-nil means a comment { ... } is set after the ends which ends cases and - functions. The name of the function or case will be set between the braces. + functions. The name of the function or case will be set between the braces. `pascal-auto-lineup' (default t) List of contexts where auto lineup of :'s or ='s should be done. @@ -496,7 +497,8 @@ This puts the mark at the end, and point at the beginning." (pascal-beg-of-defun)) (defun pascal-comment-area (start end) - "Put the region into a Pascal comment.\\ + "Put the region into a Pascal comment. +\\ The comments that are in this area are \"deformed\": `*)' becomes `!(*' and `}' becomes `!{'. These deformed comments are returned to normal if you use diff --git a/lisp/progmodes/python.el b/lisp/progmodes/python.el index 89eefd1f08a..f0a86843683 100644 --- a/lisp/progmodes/python.el +++ b/lisp/progmodes/python.el @@ -1140,8 +1140,8 @@ fontified." For example, Lvl1 | Lvl2[Lvl3[Lvl4[Lvl5 | None]], Lvl2]. This structure is represented via nesting binary_operator and subscript nodes. This function iterates over all levels and -highlight identifier nodes. If TYPE-REGEX is not nil fontify type -identifier only if it matches against TYPE-REGEX. NODE is the +highlight identifier nodes. If TYPE-REGEX is not nil fontify type +identifier only if it matches against TYPE-REGEX. NODE is the binary_operator node. OVERRIDE is the override flag described in `treesit-font-lock-rules'. START and END mark the region to be fontified." diff --git a/lisp/progmodes/ruby-mode.el b/lisp/progmodes/ruby-mode.el index f6ef175e11e..3bcfa9ee7df 100644 --- a/lisp/progmodes/ruby-mode.el +++ b/lisp/progmodes/ruby-mode.el @@ -336,7 +336,7 @@ Only has effect when `ruby-use-smie' is t." "If non-nil, align chained method calls. Each method call on a separate line will be aligned to the column -of its parent. Example: +of its parent. Example: my_array.select { |str| str.size > 5 } .map { |str| str.downcase } @@ -386,7 +386,7 @@ Only has effect when `ruby-use-smie' is t." "Non-nil to align the body of a block to the statement's start. The body and the closer will be aligned to the column where the -statement containing the block starts. Example: +statement containing the block starts. Example: foo.bar .each do @@ -2557,7 +2557,7 @@ If there is no Rubocop config file, Rubocop will be passed a flag "Non-nil with allow `ruby-flymake-rubocop' to use `bundle exec'. When the value is `check', it will first see whether Gemfile exists in the same directory as the configuration file, and whether it mentions -the gem \"rubocop\". When t, it's used unconditionally. " +the gem \"rubocop\". When t, it is used unconditionally." :type '(choice (const :tag "Always" t) (const :tag "No" nil) (const :tag "If rubocop is in Gemfile" check)) diff --git a/lisp/progmodes/rust-ts-mode.el b/lisp/progmodes/rust-ts-mode.el index baf0e1ec013..571ffa9b220 100644 --- a/lisp/progmodes/rust-ts-mode.el +++ b/lisp/progmodes/rust-ts-mode.el @@ -427,7 +427,7 @@ delimiters < and >'s." (?> '(5 . ?<)))))))) (defun rust-ts-mode--prettify-symbols-compose-p (start end match) - "Return true iff the symbol MATCH should be composed. + "Return non-nil if the symbol MATCH should be composed. See `prettify-symbols-compose-predicate'." (and (fboundp 'prettify-symbols-default-compose-p) (prettify-symbols-default-compose-p start end match) diff --git a/lisp/progmodes/verilog-mode.el b/lisp/progmodes/verilog-mode.el index a83bad0e8ed..65545d523a8 100644 --- a/lisp/progmodes/verilog-mode.el +++ b/lisp/progmodes/verilog-mode.el @@ -9950,7 +9950,7 @@ For example if declare A A (.B(SIG)) then B will be included in the list." (setq sig-list (cons (list (match-string-no-properties 1) nil nil) sig-list)))) sig-list))) -(defvar verilog-cache-has-lisp nil "True if any AUTO_LISP in buffer.") +(defvar verilog-cache-has-lisp nil "Non-nil if any AUTO_LISP in buffer.") (make-variable-buffer-local 'verilog-cache-has-lisp) (defun verilog-read-auto-lisp-present () @@ -14043,7 +14043,7 @@ Typing \\[verilog-auto] will call my-verilog-insert-hello and expand the above into: /*AUTOINSERTLISP(my-verilog-insert-hello \"world\")*/ - // Beginning of automatic insert lisp + // Beginning of automatic insert Lisp initial $write(\"hello world\"); // End of automatics @@ -15400,7 +15400,7 @@ and the case items." (defun verilog-highlight-region (beg end _old-len) "Colorize included files and modules in the (changed?) region. -Clicking on the middle-mouse button loads them in a buffer (as in dired)." +Clicking on the middle-mouse button loads them in a buffer (as in Dired)." (when (or verilog-highlight-includes verilog-highlight-modules) (save-excursion diff --git a/lisp/progmodes/xref.el b/lisp/progmodes/xref.el index 710293b8dbc..5ecb8664da0 100644 --- a/lisp/progmodes/xref.el +++ b/lisp/progmodes/xref.el @@ -487,7 +487,7 @@ Override existing value with NEW-VALUE if NEW-VALUE is set." (set-window-parameter w 'xref--history (xref--make-xref-history)))))) (defun xref--get-history () - "Return xref history using xref-history-storage." + "Return xref history using `xref-history-storage'." (funcall xref-history-storage)) (defun xref--push-backward (m) commit 6757f8e67d3bdfe338810fc26408a62e7839afe7 Author: Stefan Kangas Date: Sun Jul 7 14:27:14 2024 +0200 Checkdoc fixes in Org Mode * lisp/org/ob-core.el: * lisp/org/ob-exp.el: * lisp/org/ob-lob.el: * lisp/org/ob-plantuml.el (org-babel-execute:plantuml): * lisp/org/ob-python.el (org-babel-python--command) (org-babel-python-initiate-session-by-key) (org-babel-python-initiate-session): * lisp/org/ob-scheme.el (org-babel-scheme-make-session-name): * lisp/org/ob-tangle.el (org-babel-find-file-noselect-refresh) (org-babel-interpret-file-mode): * lisp/org/ob.el: * lisp/org/org-agenda.el (org-agenda-mouse-1-follows-link) (org-agenda-start-with-archives-mode) (org-agenda-previous-line): * lisp/org/org-clock.el (org-clock-save, org-clock-load): * lisp/org/org-element-ast.el (org-element-type-p): * lisp/org/org-faces.el (org-cycle-level-faces): * lisp/org/org-fold-core.el (org-fold-core--isearch-overlays): * lisp/org/org-fold.el (org-fold--extend-changed-region): * lisp/org/org-goto.el: * lisp/org/org-habit.el (org-habit-show-all-today): * lisp/org/org-inlinetask.el (org-inlinetask-in-task-p): * lisp/org/org-macs.el (org-current-text-column): * lisp/org/org-mobile.el (org-mobile-check-setup): * lisp/org/org-mouse.el (org-mouse-bolp): * lisp/org/org-refile.el (org-refile): * lisp/org/org-src.el (org-src-do-key-sequence-at-code-block): * lisp/org/org-table.el (orgtbl-after-send-table-hook) (orgtbl-self-insert-command, orgtbl-to-orgtbl): * lisp/org/org.el (org-read-date-popup-calendar, org-finish-function) (org-occur-parameters, org-self-insert-command, org-ctrl-c-ctrl-c-hook) (org-ctrl-c-ctrl-c-final-hook, org-submit-bug-report) (org--single-lines-list-is-paragraph): * lisp/org/ox-icalendar.el (org-icalendar--vtodo): * lisp/org/ox-latex.el (org-latex-generate-engraved-preamble): (org-latex-src--engrave-code): * lisp/org/ox-publish.el (org-publish-project-alist): * lisp/org/ox.el (org-export-data): Various checkdoc fixes. diff --git a/lisp/org/ob-core.el b/lisp/org/ob-core.el index bd96556846f..60f213fe751 100644 --- a/lisp/org/ob-core.el +++ b/lisp/org/ob-core.el @@ -22,6 +22,8 @@ ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs. If not, see . +;;; Commentary: + ;;; Code: (require 'org-macs) diff --git a/lisp/org/ob-exp.el b/lisp/org/ob-exp.el index 5516530c5b7..30b2a42a6c4 100644 --- a/lisp/org/ob-exp.el +++ b/lisp/org/ob-exp.el @@ -22,6 +22,8 @@ ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs. If not, see . +;;; Commentary: + ;;; Code: (require 'org-macs) diff --git a/lisp/org/ob-lob.el b/lisp/org/ob-lob.el index 110675fc561..eaa66872f1f 100644 --- a/lisp/org/ob-lob.el +++ b/lisp/org/ob-lob.el @@ -22,6 +22,8 @@ ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs. If not, see . +;;; Commentary: + ;;; Code: (require 'org-macs) diff --git a/lisp/org/ob-plantuml.el b/lisp/org/ob-plantuml.el index 17b9d140832..229b4bad2c8 100644 --- a/lisp/org/ob-plantuml.el +++ b/lisp/org/ob-plantuml.el @@ -116,7 +116,7 @@ This function is called by `org-babel-execute-src-block'." (let* ((do-export (member "file" (cdr (assq :result-params params)))) (out-file (if do-export (or (cdr (assq :file params)) - (error "No :file provided but :results set to file. For plain text output, set :results to verbatim")) + (error "No :file provided but :results set to file. For plain text output, set :results to verbatim")) (org-babel-temp-file "plantuml-" ".txt"))) (cmdline (cdr (assq :cmdline params))) (in-file (org-babel-temp-file "plantuml-")) diff --git a/lisp/org/ob-python.el b/lisp/org/ob-python.el index 1afbcb5ded5..8a3c24f7038 100644 --- a/lisp/org/ob-python.el +++ b/lisp/org/ob-python.el @@ -279,7 +279,7 @@ be removed after minimum supported version reaches emacs29." This checks `org-babel-python-command', and then `org-babel-python-command-session' (if IS-SESSION) or `org-babel-python-command-nonsession' (if not IS-SESSION). If -IS-SESSION, this might return `nil', which means to use +IS-SESSION, this might return nil, which means to use `python-shell-calculate-command'." (or (unless (eq org-babel-python-command 'auto) org-babel-python-command) @@ -300,7 +300,7 @@ unless the Python session was created outside Org." (defun org-babel-python-initiate-session-by-key (&optional session) "Initiate a python session. If there is not a current inferior-process-buffer matching -SESSION then create it. If inferior process already +SESSION then create it. If inferior process already exists (e.g. if it was manually started with `run-python'), make sure it's configured to work with ob-python. If session has already been configured as such, do nothing. Return the @@ -356,7 +356,7 @@ initialized session." (defun org-babel-python-initiate-session (&optional session _params) "Initiate Python session named SESSION according to PARAMS. If there is not a current inferior-process-buffer matching -SESSION then create it. If inferior process already +SESSION then create it. If inferior process already exists (e.g. if it was manually started with `run-python'), make sure it's configured to work with ob-python. If session has already been configured as such, do nothing." diff --git a/lisp/org/ob-scheme.el b/lisp/org/ob-scheme.el index 3f04667f276..29fdcd1ec6d 100644 --- a/lisp/org/ob-scheme.el +++ b/lisp/org/ob-scheme.el @@ -143,14 +143,14 @@ If the variables HOST and PORT are set, connect to the running Scheme REPL." (current-buffer))))) (defun org-babel-scheme-make-session-name (buffer name impl) - "Generate a name for the session buffer. + "Generate a NAME for the session BUFFER. For a named session, the buffer name will be the session name. If the session is unnamed (nil), generate a name. If the session is `none', use nil for the session name, and -org-babel-scheme-execute-with-geiser will use a temporary session." +`org-babel-scheme-execute-with-geiser' will use a temporary session." (cond ((not name) (concat buffer " " (symbol-name impl) " REPL")) ((string= name "none") nil) (name))) diff --git a/lisp/org/ob-tangle.el b/lisp/org/ob-tangle.el index c89763efad7..fe143b039ff 100644 --- a/lisp/org/ob-tangle.el +++ b/lisp/org/ob-tangle.el @@ -184,8 +184,7 @@ replace contents otherwise." :safe t) (defun org-babel-find-file-noselect-refresh (file) - "Find file ensuring that the latest changes on disk are -represented in the file." + "Find file ensuring that the latest changes on disk are represented in the file." (find-file-noselect file 'nowarn) (with-current-buffer (get-file-buffer file) (revert-buffer t t t))) @@ -386,10 +385,10 @@ The following forms are currently recognized: ((integerp mode) (if (string-match-p "^[0-7][0-7][0-7]$" (format "%o" mode)) mode - (user-error "%1$o is not a valid file mode octal. \ + (user-error "%1$o is not a valid file mode octal. \ Did you give the decimal value %1$d by mistake?" mode))) ((not (stringp mode)) - (error "File mode %S not recognized as a valid format." mode)) + (error "File mode %S not recognized as a valid format" mode)) ((string-match-p "^o0?[0-7][0-7][0-7]$" mode) (string-to-number (replace-regexp-in-string "^o" "" mode) 8)) ((string-match-p "^[ugoa]*\\(?:[+=-][rwxXstugo]*\\)+\\(,[ugoa]*\\(?:[+=-][rwxXstugo]*\\)+\\)*$" mode) @@ -400,7 +399,7 @@ Did you give the decimal value %1$d by mistake?" mode))) ",g=" (delete ?- (substring mode 3 6)) ",o=" (delete ?- (substring mode 6 9))) 0)) - (t (error "File mode %S not recognized as a valid format. See `org-babel-interpret-file-mode'." mode)))) + (t (error "File mode %S not recognized as a valid format. See `org-babel-interpret-file-mode'" mode)))) (defun org-babel-tangle-clean () "Remove comments inserted by `org-babel-tangle'. diff --git a/lisp/org/ob.el b/lisp/org/ob.el index d3a29b83351..064faafd7cf 100644 --- a/lisp/org/ob.el +++ b/lisp/org/ob.el @@ -21,6 +21,8 @@ ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs. If not, see . +;;; Commentary: + ;;; Code: (require 'org-macs) diff --git a/lisp/org/org-agenda.el b/lisp/org/org-agenda.el index 10f25be8a8d..b2a5ff92734 100644 --- a/lisp/org/org-agenda.el +++ b/lisp/org/org-agenda.el @@ -1041,7 +1041,7 @@ headlines as the agenda display heavily relies on them." :type 'hook) (defcustom org-agenda-mouse-1-follows-link nil - "Non-nil means mouse-1 on a link will follow the link in the agenda. + "Non-nil means \\`mouse-1' on a link will follow the link in the agenda. A longer mouse click will still set point. Needs to be set before org.el is loaded." :group 'org-agenda-startup @@ -1100,7 +1100,7 @@ removed from entry text before it is shown in the agenda." :type 'string) (defcustom org-agenda-start-with-archives-mode nil - "Initial value of archive-mode in a newly created agenda window. + "Initial value of archive mode in a newly created agenda window. See `org-agenda-archives-mode' for acceptable values and their meaning." :group 'org-agenda-startup @@ -9190,7 +9190,7 @@ When called with a prefix argument, include all archive files as well." (org-agenda-do-context-action)) (defun org-agenda-previous-line () - "Move cursor to the previous line, and show if follow-mode is active." + "Move cursor to the previous line, and show if follow mode is active." (interactive) (call-interactively 'previous-line) (org-agenda-do-context-action)) diff --git a/lisp/org/org-clock.el b/lisp/org/org-clock.el index c6fd507b08b..316cd7eee4b 100644 --- a/lisp/org/org-clock.el +++ b/lisp/org/org-clock.el @@ -3261,7 +3261,7 @@ The details of what will be saved are regulated by the variable (and (buffer-live-p b) (buffer-file-name b) (or (not org-clock-persist-query-save) - (y-or-n-p (format "Save current clock (%s) " + (y-or-n-p (format "Save current clock (%s)?" org-clock-heading)))))) (insert (format "(setq org-clock-stored-resume-clock '(%S . %d))\n" @@ -3301,7 +3301,7 @@ The details of what will be saved are regulated by the variable (`(,(and file (pred file-exists-p)) . ,position) (with-current-buffer (find-file-noselect file) (when (or (not org-clock-persist-query-resume) - (y-or-n-p (format "Resume clock (%s) " + (y-or-n-p (format "Resume clock (%s)?" (save-excursion (goto-char position) (org-get-heading t t))))) diff --git a/lisp/org/org-element-ast.el b/lisp/org/org-element-ast.el index 2c767e1ad24..f3f74928004 100644 --- a/lisp/org/org-element-ast.el +++ b/lisp/org/org-element-ast.el @@ -231,7 +231,7 @@ when NODE is an anonymous node." (define-inline org-element-type-p (node types) "Return non-nil when NODE type is one of TYPES. - TYPES can be a type symbol or a list of symbols." +TYPES can be a type symbol or a list of symbols." (inline-letevals (node types) (if (listp (inline-const-val types)) (inline-quote (memq (org-element-type ,node t) ,types)) diff --git a/lisp/org/org-faces.el b/lisp/org/org-faces.el index 785fb22dbc0..21b23b641ca 100644 --- a/lisp/org/org-faces.el +++ b/lisp/org/org-faces.el @@ -690,8 +690,8 @@ If it is less than 8, the level-1 face gets reused for level N+1 etc." (defcustom org-cycle-level-faces t "Non-nil means level styles cycle after level `org-n-level-faces'. Then so level org-n-level-faces+1 is styled like level 1. -If nil, then all levels >= org-n-level-faces are styled like -level org-n-level-faces." +If nil, then all levels >= `org-n-level-faces' are styled like +level `org-n-level-faces'." :group 'org-appearance :group 'org-faces :version "24.1" diff --git a/lisp/org/org-fold-core.el b/lisp/org/org-fold-core.el index 8372b86b087..4eb875aff2f 100644 --- a/lisp/org/org-fold-core.el +++ b/lisp/org/org-fold-core.el @@ -160,7 +160,7 @@ ;; If one wants to search invisible text without using the provided ;; functions, it is important to keep in mind that 'invisible text ;; property may have multiple possible values (not just nil and -;; t). Hence, (next-single-char-property-change pos 'invisible) is not +;; t). Hence, (next-single-char-property-change pos 'invisible) is not ;; guaranteed to return the boundary of invisible/visible text. ;;; Interactive searching inside folded text (via isearch) @@ -1172,7 +1172,7 @@ because otherwise all these markers will point to nowhere." This is used to allow searching in regions hidden via text properties. As for [2020-05-09 Sat], Isearch only has special handling of hidden overlays. Any text hidden via text properties is not revealed even if `search-invisible' -is set to `t'.") +is set to t.") (defvar-local org-fold-core--isearch-local-regions (make-hash-table :test 'equal) "Hash table storing temporarily shown folds from isearch matches.") diff --git a/lisp/org/org-fold.el b/lisp/org/org-fold.el index 1b62168c483..33b43fd3b56 100644 --- a/lisp/org/org-fold.el +++ b/lisp/org/org-fold.el @@ -733,8 +733,7 @@ go to the parent and show the entire tree." ;;; Handling changes in folded elements (defun org-fold--extend-changed-region (from to) - "Consider folded regions in the next/previous line when fixing -region visibility. + "Consider folded regions in the next/previous line when fixing region visibility. This function is intended to be used as a member of `org-fold-core-extend-changed-region-functions'." ;; If the edit is done in the first line of a folded drawer/block, diff --git a/lisp/org/org-goto.el b/lisp/org/org-goto.el index 5e4c05a7683..cb74942a5e7 100644 --- a/lisp/org/org-goto.el +++ b/lisp/org/org-goto.el @@ -20,6 +20,8 @@ ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs. If not, see . +;;; Commentary: + ;;; Code: (require 'org-macs) diff --git a/lisp/org/org-habit.el b/lisp/org/org-habit.el index e17ee27fc6f..8b344f0c99f 100644 --- a/lisp/org/org-habit.el +++ b/lisp/org/org-habit.el @@ -69,7 +69,7 @@ relative to the current effective date." :type 'boolean) (defcustom org-habit-show-all-today nil - "If non-nil, will show the consistency graph of all habits on + "If non-nil, show the consistency graph of all habits on today's agenda, even if they are not scheduled." :group 'org-habit :type 'boolean) diff --git a/lisp/org/org-inlinetask.el b/lisp/org/org-inlinetask.el index a4136a13d2c..3292250cd69 100644 --- a/lisp/org/org-inlinetask.el +++ b/lisp/org/org-inlinetask.el @@ -172,7 +172,7 @@ The number of levels is controlled by `org-inlinetask-min-level'." (not (org-inlinetask-end-p)))) (defun org-inlinetask-in-task-p () - "Return true if point is inside an inline task." + "Return non-nil if point is inside an inline task." (save-excursion (forward-line 0) (let ((case-fold-search t)) diff --git a/lisp/org/org-macs.el b/lisp/org/org-macs.el index 694e747b04e..a6ff0e54512 100644 --- a/lisp/org/org-macs.el +++ b/lisp/org/org-macs.el @@ -1228,7 +1228,7 @@ This function forces `tab-width' value because it is used as a part of the parser, to ensure parser consistency when calculating list indentation." `(progn - (unless (= 8 tab-width) (error "Tab width in Org files must be 8, not %d. Please adjust your `tab-width' settings for Org mode." tab-width)) + (unless (= 8 tab-width) (error "Tab width in Org files must be 8, not %d. Please adjust your `tab-width' settings for Org mode" tab-width)) (string-width (buffer-substring-no-properties (line-beginning-position) (point))))) diff --git a/lisp/org/org-mobile.el b/lisp/org/org-mobile.el index 82f97fd3635..2a6dd4e7986 100644 --- a/lisp/org/org-mobile.el +++ b/lisp/org/org-mobile.el @@ -392,7 +392,7 @@ agenda view showing the flagged items." (org-agenda nil "?")))))) (defun org-mobile-check-setup () - "Check if org-mobile-directory has been set up." + "Check if `org-mobile-directory' has been set up." (org-mobile-cleanup-encryption-tempfile) (unless (and org-directory (stringp org-directory) diff --git a/lisp/org/org-mouse.el b/lisp/org/org-mouse.el index 6bc7f788fb9..322d9868266 100644 --- a/lisp/org/org-mouse.el +++ b/lisp/org/org-mouse.el @@ -561,7 +561,7 @@ SCHEDULED: or DEADLINE: or ANYTHINGLIKETHIS:" (save-excursion (org-apply-on-list wrap-fun nil))))) (defun org-mouse-bolp () - "Return true if there only spaces, tabs, and `*' before point. + "Return non-nil if there only spaces, tabs, and `*' before point. This means, between the beginning of line and the point." (save-excursion (skip-chars-backward " \t*") (bolp))) diff --git a/lisp/org/org-refile.el b/lisp/org/org-refile.el index 391e2402859..9dea34449a7 100644 --- a/lisp/org/org-refile.el +++ b/lisp/org/org-refile.el @@ -470,8 +470,8 @@ See also `org-refile-use-outline-path'. If you are using target caching (see `org-refile-use-cache'), you have to clear the target cache in order to find new targets. -This can be done with a `0' prefix (`C-0 C-c C-w') or a triple -prefix argument (`C-u C-u C-u C-c C-w')." +This can be done with a `0' prefix (\\`C-0 C-c C-w') or a triple +prefix argument (\\`C-u C-u C-u C-c C-w')." (interactive "P") (if (member arg '(0 (64))) (org-refile-cache-clear) diff --git a/lisp/org/org-src.el b/lisp/org/org-src.el index 262bd462814..0a9062f053a 100644 --- a/lisp/org/org-src.el +++ b/lisp/org/org-src.el @@ -950,16 +950,16 @@ remotely with point temporarily at the start of the code block in the Org buffer. This command is not bound to a key by default, to avoid conflicts -with language major mode bindings. To bind it to C-c @ in all +with language major mode bindings. To bind it to \\`C-c @' in all language major modes, you could use (add-hook \\='org-src-mode-hook (lambda () (define-key org-src-mode-map \"\\C-c@\" \\='org-src-do-key-sequence-at-code-block))) -In that case, for example, C-c @ t issued in code edit buffers -would tangle the current Org code block, C-c @ e would execute -the block and C-c @ h would display the other available +In that case, for example, \\`C-c @ t' issued in code edit buffers +would tangle the current Org code block, \\`C-c @ e' would execute +the block and \\`C-c @ h' would display the other available Org-babel commands." (interactive "kOrg-babel key: ") (if (equal key (kbd "C-g")) (keyboard-quit) diff --git a/lisp/org/org-table.el b/lisp/org/org-table.el index 4a2623b5538..8a0943a48b9 100644 --- a/lisp/org/org-table.el +++ b/lisp/org/org-table.el @@ -622,7 +622,7 @@ This variable is set by `org-before-change-function'. `org-table-align' sets it back to nil.") (defvar orgtbl-after-send-table-hook nil - "Hook for functions attaching to `C-c C-c', if the table is sent. + "Hook for functions attaching to \\`C-c C-c', if the table is sent. This can be used to add additional functionality after the table is sent to the receiver position, otherwise, if table is not sent, the functions are not run.") @@ -5423,7 +5423,7 @@ conflicting binding to this key outside `orgtbl-mode'." (org-table-next-row))) (defun orgtbl-self-insert-command (N) - "Like `self-insert-command', use overwrite-mode for whitespace in tables. + "Like `self-insert-command', use `overwrite-mode' for whitespace in tables. If the cursor is in a table looking at whitespace, the whitespace is overwritten, and the table is not marked as requiring realignment." (interactive "p") @@ -6156,7 +6156,7 @@ supported. It is also possible to use the following one: ;;;###autoload (defun orgtbl-to-orgtbl (table params) - "Convert the `orgtbl-mode' TABLE into another orgtbl-mode table. + "Convert the `orgtbl-mode' TABLE into another `orgtbl-mode' table. TABLE is a list, each entry either the symbol `hline' for a horizontal separator line, or a list of fields for that line. diff --git a/lisp/org/org.el b/lisp/org/org.el index 718d53d641b..96b0e0b0ce1 100644 --- a/lisp/org/org.el +++ b/lisp/org/org.el @@ -2670,7 +2670,7 @@ is non-nil." (defcustom org-read-date-popup-calendar t "Non-nil means pop up a calendar when prompting for a date. -In the calendar, the date can be selected with mouse-1. However, the +In the calendar, the date can be selected with \\`mouse-1'. However, the minibuffer will also be active, and you can simply enter the date as well. When nil, only the minibuffer will be available." :group 'org-time @@ -4855,7 +4855,7 @@ Respect keys that are already there." (defvar org-selected-window nil "Used in various places to store a window configuration.") (defvar org-finish-function nil - "Function to be called when `C-c C-c' is used. + "Function to be called when \\`C-c C-c' is used. This is for getting out of special buffers like capture.") (defvar org-last-state) @@ -11008,7 +11008,7 @@ containing the regular expression and the callback, onto the list. The list can contain several entries if `org-occur' has been called several time with the KEEP-PREVIOUS argument. Otherwise, this list will only contain one set of parameters. When the highlights are -removed (for example with `C-c C-c', or with the next edit (depending +removed (for example with \\`C-c C-c', or with the next edit (depending on `org-remove-highlights-with-change'), this variable is emptied as well.") @@ -17087,7 +17087,7 @@ Set `org-speed-command' to the appropriate command as a side effect." (make-string 1 (aref kv (1- (length kv))))))))) (defun org-self-insert-command (N) - "Like `self-insert-command', use overwrite-mode for whitespace in tables. + "Like `self-insert-command', use `overwrite-mode' for whitespace in tables. If the cursor is in a table looking at whitespace, the whitespace is overwritten, and the table is not marked as requiring realignment." (interactive "p") @@ -17236,9 +17236,9 @@ word constituents." (call-interactively 'transpose-words))) (defvar org-ctrl-c-ctrl-c-hook nil - "Hook for functions attaching themselves to `C-c C-c'. + "Hook for functions attaching themselves to \\`C-c C-c'. -This can be used to add additional functionality to the `C-c C-c' +This can be used to add additional functionality to the \\`C-c C-c' key which executes context-dependent commands. This hook is run before any other test, while `org-ctrl-c-ctrl-c-final-hook' is run after the last test. @@ -17249,9 +17249,9 @@ it should do its thing and then return a non-nil value. If the context is wrong, just do nothing and return nil.") (defvar org-ctrl-c-ctrl-c-final-hook nil - "Hook for functions attaching themselves to `C-c C-c'. + "Hook for functions attaching themselves to \\`C-c C-c'. -This can be used to add additional functionality to the `C-c C-c' +This can be used to add additional functionality to the \\`C-c C-c' key which executes context-dependent commands. This hook is run after any other test, while `org-ctrl-c-ctrl-c-hook' is run before the first test. @@ -19065,7 +19065,7 @@ appear in the form of file names, tags, todo states or search strings. If you answer \"yes\" to the prompt, you might want to check and remove such private information before sending the email.") (add-text-properties (point-min) (point-max) '(face org-warning)) - (when (yes-or-no-p "Include your Org configuration and Org warning log ") + (when (yes-or-no-p "Include your Org configuration and Org warning log?") (mapatoms (lambda (v) (and (boundp v) @@ -21803,7 +21803,7 @@ It also provides the following special moves for convenience: arg)) (defvar org--single-lines-list-is-paragraph t - "Treat plain lists with single line items as a whole paragraph") + "Treat plain lists with single line items as a whole paragraph.") (defun org--paragraph-at-point () "Return paragraph, or equivalent, element at point. diff --git a/lisp/org/ox-icalendar.el b/lisp/org/ox-icalendar.el index 9921865ad51..858d146d6d9 100644 --- a/lisp/org/ox-icalendar.el +++ b/lisp/org/ox-icalendar.el @@ -932,14 +932,14 @@ Return VTODO component as a string." :repeater-unit dl))))) ;; TODO Implement via RDATE with changing DURATION (org-display-warning "Not yet implemented: \ -different repeaters on SCHEDULED and DEADLINE. Skipping.") +different repeaters on SCHEDULED and DEADLINE. Skipping.") nil) ;; DEADLINE has repeater but SCHEDULED doesn't ((and dl-repeat-p (and sc (not sc-repeat-p))) ;; TODO SCHEDULED should only apply to first instance; ;; use RDATE with custom DURATION to implement that (org-display-warning "Not yet implemented: \ -repeater on DEADLINE but not SCHEDULED. Skipping.") +repeater on DEADLINE but not SCHEDULED. Skipping.") nil) ((or sc-repeat-p dl-repeat-p) (concat diff --git a/lisp/org/ox-latex.el b/lisp/org/ox-latex.el index a34646763a6..fcb0e20dc7e 100644 --- a/lisp/org/ox-latex.el +++ b/lisp/org/ox-latex.el @@ -1391,7 +1391,7 @@ default values of which are given by `org-latex-engraved-preamble' and "\n")) (t (funcall gen-theme-spec engraved-theme)))) (funcall gen-theme-spec engraved-theme)) - (warn "Cannot engrave source blocks. Consider installing `engrave-faces'.") + (warn "Cannot engrave source blocks. Consider installing `engrave-faces'.") "% WARNING syntax highlighting unavailable as engrave-faces-latex was missing.\n") "\n"))) @@ -3548,7 +3548,7 @@ and FLOAT are extracted from SRC-BLOCK and INFO in `org-latex-src-block'." When the THEME symbol is non-nil, that theme will be used. When INLINE is nil, a Verbatim environment wrapped in a Code -environment will be used. When t, a Verb command will be used. +environment will be used. When t, a Verb command will be used. When OPTIONS is provided, as either a string or list of key-value pairs accepted by `org-latex--make-option-string', it is passed @@ -3591,7 +3591,7 @@ to the Verbatim environment or Verb command." engraved-wrapped "}") engraved-wrapped)) - (user-error "Cannot engrave code as `engrave-faces-latex' is unavailable."))) + (user-error "Cannot engrave code as `engrave-faces-latex' is unavailable"))) (cl-defun org-latex-src-block--engraved (&key src-block info lang caption caption-above-p num-start retain-labels attributes float &allow-other-keys) diff --git a/lisp/org/ox-publish.el b/lisp/org/ox-publish.el index 13f9b6b53b4..9f943cedc34 100644 --- a/lisp/org/ox-publish.el +++ b/lisp/org/ox-publish.el @@ -88,7 +88,7 @@ cdr of each element is in one of the following forms: (:components (\"project-1\" \"project-2\" ...)) -When the CDR of an element of org-publish-project-alist is in +When the CDR of an element of `org-publish-project-alist' is in this second form, the elements of the list after `:components' are taken to be components of the project, which group together files requiring different publishing options. When you publish diff --git a/lisp/org/ox.el b/lisp/org/ox.el index 6fa21be9063..75839e6c88a 100644 --- a/lisp/org/ox.el +++ b/lisp/org/ox.el @@ -1931,7 +1931,7 @@ Return a string." (progn ,@body) (org-link-broken (pcase (plist-get info :with-broken-links) - (`nil (user-error "Org export aborted. Unable to resolve link: %S\nSee `org-export-with-broken-links'." (nth 1 err))) + (`nil (user-error "Org export aborted. Unable to resolve link: %S\nSee `org-export-with-broken-links'" (nth 1 err))) (`mark (org-export-data (format "[BROKEN LINK: %s]" (nth 1 err)) info)) (_ nil)))))) commit 9fcee3c1d1eb6ce735dc69ee77b0c81900c19c3d Author: Stefan Kangas Date: Sun Jul 7 12:45:03 2024 +0200 Clarify `checkdoc-max-keyref-before-warn` docstring * lisp/emacs-lisp/checkdoc.el (checkdoc-max-keyref-before-warn): Clarify and reflow docstring. Fix warning about overly long docstring. diff --git a/lisp/emacs-lisp/checkdoc.el b/lisp/emacs-lisp/checkdoc.el index c22dfb2eb26..fd25b0f981f 100644 --- a/lisp/emacs-lisp/checkdoc.el +++ b/lisp/emacs-lisp/checkdoc.el @@ -262,14 +262,15 @@ with these words enabled." ;;;###autoload(put 'checkdoc-ispell-list-words 'safe-local-variable #'list-of-strings-p) (defcustom checkdoc-max-keyref-before-warn nil - "If non-nil, number of \\\\=[command-to-keystroke] tokens allowed in a doc string. -Any more than this and a warning is generated suggesting that the construct -\\\\={mapvar} be used instead. If the value is nil, never warn. - -It used to not be practical to use `\\\\=[...]' very many times, -because display of the documentation string would become slow. -This is not an issue on modern machines, unless you have -thousands of substitutions." + "Maximum number of \\\\=[command-to-keystroke] tokens allowed in a doc string. + +Any more than this and a warning is generated suggesting that the +construct \\\\={mapvar} be used instead. If the value is nil, never +warn. + +It used to be impractical to use `\\\\=[...]' very many times, because +display of the documentation string would become slow. This is not an +issue on modern machines, unless you have thousands of substitutions." :type '(choice (const nil) integer) :version "28.1") commit b249f022f1285aaf02705b6ac239d95e3b413c18 Author: Juri Linkov Date: Sun Jul 7 09:57:34 2024 +0300 * lisp/files.el (insert-directory): Quote switches in wildcard case. Use shell-quote-wildcard-pattern on the switches string split by split-string-and-unquote. This helps to quote such switches as "--block-size='1" (bug#71935). diff --git a/lisp/files.el b/lisp/files.el index 2fda10fc50e..e552f3ac413 100644 --- a/lisp/files.el +++ b/lisp/files.el @@ -8193,9 +8193,15 @@ normally equivalent short `-D' option is just passed on to "\\") ; Disregard Unix shell aliases! insert-directory-program " -d " - (if (stringp switches) - switches - (mapconcat #'identity switches " ")) + ;; Quote switches that require quoting + ;; such as "--block-size='1". But don't + ;; quote switches that use patterns + ;; such as "--ignore=PATTERN" (bug#71935). + (mapconcat #'shell-quote-wildcard-pattern + (if (stringp switches) + (split-string-and-unquote switches) + switches) + " ") " -- " ;; Quote some characters that have ;; special meanings in shells; but commit 8911d53ce5d8c67327704b7bf55ada14024766d0 Author: Juri Linkov Date: Sun Jul 7 09:52:01 2024 +0300 Fix uses of 'dired-omit-mode' (bug#71905) * lisp/dired.el (dired-jump): Disable dired-omit-mode with -1. * lisp/files.el (recover-session): Disable dired-omit-mode explicitly afterwards instead of modifying dired-mode-hook that fails when it contains a lambda. diff --git a/lisp/dired.el b/lisp/dired.el index baac246dd5e..33b79cbef85 100644 --- a/lisp/dired.el +++ b/lisp/dired.el @@ -5183,7 +5183,7 @@ Interactively with prefix argument, read FILE-NAME." (dired-goto-file file)) ;; Toggle omitting, if it is on, and try again. (when (bound-and-true-p dired-omit-mode) - (dired-omit-mode) + (dired-omit-mode -1) (dired-goto-file file))))))))) ;;;###autoload diff --git a/lisp/files.el b/lisp/files.el index c518273bd29..2fda10fc50e 100644 --- a/lisp/files.el +++ b/lisp/files.el @@ -7263,7 +7263,7 @@ auto-save file, if that is more recent than the visited file." (after-find-file nil nil t)) (t (user-error "Recover-file canceled"))))) -(defvar dired-mode-hook) +(declare-function dired-omit-mode "dired-x" (&optional arg)) (defun recover-session () "Recover auto save files from a previous Emacs session. @@ -7284,14 +7284,12 @@ Then you'll be asked about a number of files to recover." (concat "\\`" (regexp-quote nd))) t) (error "No previous sessions to recover"))) - (require 'dired) - (let ((ls-lisp-support-shell-wildcards t) - ;; Ensure that we don't omit the session files as the user may - ;; have (as suggested by the manual) `dired-omit-mode' in the - ;; hook. - (dired-mode-hook (delete 'dired-omit-mode dired-mode-hook))) + (let ((ls-lisp-support-shell-wildcards t)) (dired (concat auto-save-list-file-prefix "*") - (concat (connection-local-value dired-listing-switches) " -t"))) + (concat (connection-local-value dired-listing-switches) " -t")) + ;; Toggle omitting, if it is on. + (when (bound-and-true-p dired-omit-mode) + (dired-omit-mode -1))) (use-local-map (nconc (make-sparse-keymap) (current-local-map))) (define-key (current-local-map) "\C-c\C-c" 'recover-session-finish) (save-excursion