commit c61bfe0a3adab1a9fd0dc283cbf8291a78ed6da1 (HEAD, refs/remotes/origin/master) Author: Lars Ingebrigtsen Date: Sat Sep 21 10:16:10 2019 +0200 Mention image caching in the `image-size' doc string * src/image.c (Fimage_size): Mention that this function caches images, and what to do about that (bug#33275). diff --git a/src/image.c b/src/image.c index fe7bd90b05..5183558029 100644 --- a/src/image.c +++ b/src/image.c @@ -1050,8 +1050,13 @@ DEFUN ("image-size", Fimage_size, Simage_size, 1, 3, 0, doc: /* Return the size of image SPEC as pair (WIDTH . HEIGHT). PIXELS non-nil means return the size in pixels, otherwise return the size in canonical character units. + FRAME is the frame on which the image will be displayed. FRAME nil -or omitted means use the selected frame. */) +or omitted means use the selected frame. + +Calling this function will result in the image being stored in the +image cache. If this is not desirable, call `image-flush' after +calling this function. */) (Lisp_Object spec, Lisp_Object pixels, Lisp_Object frame) { Lisp_Object size; commit 321175434a7bfec1be563a6eb2665f085cd40686 Author: Lars Ingebrigtsen Date: Sat Sep 21 09:58:07 2019 +0200 Mention how to listen to all interfaces in make-network-process * src/process.c (Fmake_network_process): Mention how to listen to all interfaces (bug#34617). diff --git a/src/process.c b/src/process.c index a95192d8fb..d30b17d45e 100644 --- a/src/process.c +++ b/src/process.c @@ -3758,8 +3758,9 @@ also nil, meaning that this process is not associated with any buffer. address. The symbol `local' specifies the local host. If specified for a server process, it must be a valid name or address for the local host, and only clients connecting to that address will be accepted. -`local' will use IPv4 by default, use a FAMILY of 'ipv6 to override -this. +If all interfaces should be bound, an address of \"0.0.0.0\" (for +ipv4) or \"::\" (for ipv6) can be used. `local' will use IPv4 by +default, use a FAMILY of 'ipv6 to override this. :service SERVICE -- SERVICE is name of the service desired, or an integer specifying a port number to connect to. If SERVICE is t, commit 8f5da5587f41bec80ea32c6c9c670d132c7b6a5e Author: Michael Albinus Date: Sat Sep 21 09:53:18 2019 +0200 * lisp/net/tramp.el (tramp-handle-file-modes): Check for nil file-attributes. diff --git a/lisp/net/tramp.el b/lisp/net/tramp.el index b044762b70..b17e4a787c 100644 --- a/lisp/net/tramp.el +++ b/lisp/net/tramp.el @@ -3152,10 +3152,10 @@ User is always nil." (defun tramp-handle-file-modes (filename) "Like `file-modes' for Tramp files." - (let ((truename (or (file-truename filename) filename))) - (when (file-exists-p truename) - (tramp-mode-string-to-int - (tramp-compat-file-attribute-modes (file-attributes truename)))))) + ;; Starting with Emacs 25.1, `when-let' can be used. + (let ((attrs (file-attributes (or (file-truename filename) filename)))) + (when attrs + (tramp-mode-string-to-int (tramp-compat-file-attribute-modes attrs))))) ;; Localname manipulation functions that grok Tramp localnames... (defun tramp-handle-file-name-as-directory (file) commit 0dd4b87e61e2d45b958b7afb888a6de5222ed172 Author: Eli Zaretskii Date: Sat Sep 21 10:05:20 2019 +0300 * lisp/completion.el (completion-kill-region): Doc fix. diff --git a/lisp/completion.el b/lisp/completion.el index 77761d695b..ca4de0afee 100644 --- a/lisp/completion.el +++ b/lisp/completion.el @@ -2138,7 +2138,7 @@ Also sets up so that exiting Emacs will automatically save the file." "Kill between point and mark. The text is deleted but saved in the kill ring. The command \\[yank] can retrieve it from there. -/(If you want to kill and then yank immediately, use \\[copy-region-as-kill].) +\(If you want to kill and then yank immediately, use \\[copy-region-as-kill].) This is the primitive for programs to kill text (as opposed to deleting it). Supply two arguments, character positions indicating the stretch of text commit 87b7c069583ddccae89791b2389bd872a49bc1b0 Author: Eric Abrahamsen Date: Fri Sep 20 17:38:03 2019 -0700 Fix to a81223aeaa * lisp/gnus/gnus-registry.el (gnus-registry-article-marks-to-chars): (gnus-registry-article-marks-to-names): The registry is an object, not a hash table. diff --git a/lisp/gnus/gnus-registry.el b/lisp/gnus/gnus-registry.el index ff0d4bad71..cc932956f5 100644 --- a/lisp/gnus/gnus-registry.el +++ b/lisp/gnus/gnus-registry.el @@ -1007,7 +1007,7 @@ Uses `gnus-registry-marks' to find what shortcuts to install." ;; (defalias 'gnus-user-format-function-M 'gnus-registry-article-marks-to-chars) (defun gnus-registry-article-marks-to-chars (headers) "Show the marks for an article by the :char property." - (if (hash-table-p gnus-registry-db) + (if (object-p gnus-registry-db) (let* ((id (mail-header-message-id headers)) (marks (when id (gnus-registry-get-id-key id 'mark)))) (concat (delq nil @@ -1023,7 +1023,7 @@ Uses `gnus-registry-marks' to find what shortcuts to install." ;; (defalias 'gnus-user-format-function-M 'gnus-registry-article-marks-to-names) (defun gnus-registry-article-marks-to-names (headers) "Show the marks for an article by name." - (if (hash-table-p gnus-registry-db) + (if (object-p gnus-registry-db) (let* ((id (mail-header-message-id headers)) (marks (when id (gnus-registry-get-id-key id 'mark)))) (mapconcat (lambda (mark) (symbol-name mark)) marks ",")) commit 7828001aef134bf3a062edcea92cd0ce0dac407e Author: Lars Ingebrigtsen Date: Sat Sep 21 01:41:50 2019 +0200 Allow the user to specify Content-type in Message mode * lisp/gnus/message.el (message-encode-message-body): Pass in the content type if the user has given one. * lisp/gnus/mml.el (mml-parse-1): Remove bogus peek at Content-type (there are no headers here) (bug#36527). * lisp/gnus/mml.el (mml-generate-mime): Respect that. diff --git a/lisp/gnus/message.el b/lisp/gnus/message.el index ef6455ac5c..ef9f8429d4 100644 --- a/lisp/gnus/message.el +++ b/lisp/gnus/message.el @@ -8061,7 +8061,10 @@ regexp VARSTR." (message-goto-body) (save-restriction (narrow-to-region (point) (point-max)) - (let ((new (mml-generate-mime))) + (let ((new (mml-generate-mime nil + (save-restriction + (message-narrow-to-headers) + (mail-fetch-field "content-type"))))) (when new (delete-region (point-min) (point-max)) (insert new) diff --git a/lisp/gnus/mml.el b/lisp/gnus/mml.el index 4a0d40ac0e..7fd78d7b9c 100644 --- a/lisp/gnus/mml.el +++ b/lisp/gnus/mml.el @@ -295,14 +295,6 @@ part. This is for the internal use, you should never modify the value.") (t (mm-find-mime-charset-region point (point) mm-hack-charsets)))) - ;; If the user has inserted a Content-Type header, then - ;; respect that instead of overwriting with "text/plain". - (save-restriction - (narrow-to-region point (point)) - (let ((content-type (mail-fetch-field "content-type"))) - (when (and content-type - (eq (car tag) 'part)) - (setcdr (assq 'type tag) content-type)))) (when (and (not raw) (memq nil charsets)) (if (or (memq 'unknown-encoding mml-confirmation-set) (message-options-get 'unknown-encoding) @@ -479,15 +471,22 @@ If MML is non-nil, return the buffer up till the correspondent mml tag." (declare-function libxml-parse-html-region "xml.c" (start end &optional base-url discard-comments)) -(defun mml-generate-mime (&optional multipart-type) +(defun mml-generate-mime (&optional multipart-type content-type) "Generate a MIME message based on the current MML document. MULTIPART-TYPE defaults to \"mixed\", but can also -be \"related\" or \"alternate\"." +be \"related\" or \"alternate\". + +If CONTENT-TYPE (and there's only one part), override the content +type detected." (let ((cont (mml-parse)) (mml-multipart-number mml-multipart-number) (options message-options)) (if (not cont) nil + (when (and (consp (car cont)) + (= (length cont) 1) + content-type) + (setcdr (assq 'type (cdr (car cont))) content-type)) (when (and (consp (car cont)) (= (length cont) 1) (fboundp 'libxml-parse-html-region) commit c56fabdfc731a8498b9ee8e9c988f85180de690f Author: Lars Ingebrigtsen Date: Sat Sep 21 00:45:34 2019 +0200 Move describe-face to the new help-fns machinery * lisp/help-fns.el (describe-face): Move to here from faces.el and split up (bug#36670). (help-fns--face-custom-version-info): (help-fns--face-attributes): Factored out into own functions. (help-fns-describe-face-functions): New variable. * lisp/emacs-lisp/subr-x.el (when-let): Add autoload cookie. diff --git a/lisp/emacs-lisp/subr-x.el b/lisp/emacs-lisp/subr-x.el index bb2bf3dd5f..3da52418fe 100644 --- a/lisp/emacs-lisp/subr-x.el +++ b/lisp/emacs-lisp/subr-x.el @@ -182,6 +182,7 @@ with an old syntax that accepted only one binding." (setq spec (list spec))) (list 'if-let* spec then (macroexp-progn else))) +;;;###autoload (defmacro when-let (spec &rest body) "Bind variables according to SPEC and conditionally evaluate BODY. Evaluate each binding in turn, stopping if a binding value is nil. diff --git a/lisp/faces.el b/lisp/faces.el index efae101cd8..9c5ffe1e59 100644 --- a/lisp/faces.el +++ b/lisp/faces.el @@ -1416,124 +1416,6 @@ argument, prompt for a regular expression using `read-regexp'." (dolist (face (face-list)) (copy-face face face frame disp-frame))))) -(declare-function describe-variable-custom-version-info "help-fns" - (variable &optional type)) - -(defun describe-face (face &optional frame) - "Display the properties of face FACE on FRAME. -Interactively, FACE defaults to the faces of the character after point -and FRAME defaults to the selected frame. - -If the optional argument FRAME is given, report on face FACE in that frame. -If FRAME is t, report on the defaults for face FACE (for new frames). -If FRAME is omitted or nil, use the selected frame." - (interactive (list (read-face-name "Describe face" - (or (face-at-point t) 'default) - t))) - (require 'help-fns) - (let* ((attrs '((:family . "Family") - (:foundry . "Foundry") - (:width . "Width") - (:height . "Height") - (:weight . "Weight") - (:slant . "Slant") - (:foreground . "Foreground") - (:distant-foreground . "DistantForeground") - (:background . "Background") - (:underline . "Underline") - (:overline . "Overline") - (:strike-through . "Strike-through") - (:box . "Box") - (:inverse-video . "Inverse") - (:stipple . "Stipple") - (:font . "Font") - (:fontset . "Fontset") - (:inherit . "Inherit"))) - (max-width (apply #'max (mapcar #'(lambda (x) (length (cdr x))) - attrs)))) - (help-setup-xref (list #'describe-face face) - (called-interactively-p 'interactive)) - (unless face - (setq face 'default)) - (if (not (listp face)) - (setq face (list face))) - (with-help-window (help-buffer) - (with-current-buffer standard-output - (dolist (f face (buffer-string)) - (if (stringp f) (setq f (intern f))) - ;; We may get called for anonymous faces (i.e., faces - ;; expressed using prop-value plists). Those can't be - ;; usefully customized, so ignore them. - (when (symbolp f) - (insert "Face: " (symbol-name f)) - (if (not (facep f)) - (insert " undefined face.\n") - (let ((customize-label "customize this face") - file-name) - (insert (concat " (" (propertize "sample" 'font-lock-face f) ")")) - (princ (concat " (" customize-label ")\n")) - ;; FIXME not sure how much of this belongs here, and - ;; how much in `face-documentation'. The latter is - ;; not used much, but needs to return nil for - ;; undocumented faces. - (let ((alias (get f 'face-alias)) - (face f) - obsolete) - (when alias - (setq face alias) - (insert - (format-message - "\n %s is an alias for the face `%s'.\n%s" - f alias - (if (setq obsolete (get f 'obsolete-face)) - (format-message - " This face is obsolete%s; use `%s' instead.\n" - (if (stringp obsolete) - (format " since %s" obsolete) - "") - alias) - "")))) - (insert "\nDocumentation:\n" - (substitute-command-keys - (or (face-documentation face) - "Not documented as a face.")) - "\n\n")) - (with-current-buffer standard-output - (save-excursion - (re-search-backward - (concat "\\(" customize-label "\\)") nil t) - (help-xref-button 1 'help-customize-face f))) - (setq file-name (find-lisp-object-file-name f 'defface)) - (when file-name - (princ (substitute-command-keys "Defined in `")) - (princ (file-name-nondirectory file-name)) - (princ (substitute-command-keys "'")) - ;; Make a hyperlink to the library. - (save-excursion - (re-search-backward - (substitute-command-keys "`\\([^`']+\\)'") nil t) - (help-xref-button 1 'help-face-def f file-name)) - (princ ".") - (terpri) - (terpri)) - (dolist (a attrs) - (let ((attr (face-attribute f (car a) frame))) - (insert (make-string (- max-width (length (cdr a))) ?\s) - (cdr a) ": " (format "%s" attr)) - (if (and (eq (car a) :inherit) - (not (eq attr 'unspecified))) - ;; Make a hyperlink to the parent face. - (save-excursion - (re-search-backward ": \\([^:]+\\)" nil t) - (help-xref-button 1 'help-face attr))) - (insert "\n"))))) - (terpri) - (let ((version-info (describe-variable-custom-version-info - f 'face))) - (when version-info - (insert version-info) - (terpri))))))))) - ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;;; Face specifications (defface). diff --git a/lisp/help-fns.el b/lisp/help-fns.el index 90a3571520..3c0a72e263 100644 --- a/lisp/help-fns.el +++ b/lisp/help-fns.el @@ -56,6 +56,13 @@ By convention they should indent their output by 2 spaces. Current buffer is the buffer in which we queried the variable, and the output should go to `standard-output'.") +(defvar help-fns-describe-face-functions nil + "List of functions to run in help buffer in `describe-face'. +The functions will be used (and take the same parameters) as +described in `help-fns-describe-variable-functions', except that +the functions are called with two parameters: The face and the +frame.") + ;; Functions (defvar help-definition-prefixes nil @@ -1235,6 +1242,131 @@ variable.\n"))) " This variable's value is permanent \ if it is given a local binding.\n")))))) + +;; Faces. + +;;;###autoload +(defun describe-face (face &optional frame) + "Display the properties of face FACE on FRAME. +Interactively, FACE defaults to the faces of the character after point +and FRAME defaults to the selected frame. + +If the optional argument FRAME is given, report on face FACE in that frame. +If FRAME is t, report on the defaults for face FACE (for new frames). +If FRAME is omitted or nil, use the selected frame." + (interactive (list (read-face-name "Describe face" + (or (face-at-point t) 'default) + t))) + (help-setup-xref (list #'describe-face face) + (called-interactively-p 'interactive)) + (unless face + (setq face 'default)) + (if (not (listp face)) + (setq face (list face))) + (with-help-window (help-buffer) + (with-current-buffer standard-output + (dolist (f face (buffer-string)) + (if (stringp f) (setq f (intern f))) + ;; We may get called for anonymous faces (i.e., faces + ;; expressed using prop-value plists). Those can't be + ;; usefully customized, so ignore them. + (when (symbolp f) + (insert "Face: " (symbol-name f)) + (if (not (facep f)) + (insert " undefined face.\n") + (let ((customize-label "customize this face") + file-name) + (insert (concat " (" (propertize "sample" 'font-lock-face f) ")")) + (princ (concat " (" customize-label ")\n")) + ;; FIXME not sure how much of this belongs here, and + ;; how much in `face-documentation'. The latter is + ;; not used much, but needs to return nil for + ;; undocumented faces. + (let ((alias (get f 'face-alias)) + (face f) + obsolete) + (when alias + (setq face alias) + (insert + (format-message + "\n %s is an alias for the face `%s'.\n%s" + f alias + (if (setq obsolete (get f 'obsolete-face)) + (format-message + " This face is obsolete%s; use `%s' instead.\n" + (if (stringp obsolete) + (format " since %s" obsolete) + "") + alias) + "")))) + (insert "\nDocumentation:\n" + (substitute-command-keys + (or (face-documentation face) + "Not documented as a face.")) + "\n\n")) + (with-current-buffer standard-output + (save-excursion + (re-search-backward + (concat "\\(" customize-label "\\)") nil t) + (help-xref-button 1 'help-customize-face f))) + (setq file-name (find-lisp-object-file-name f 'defface)) + (when file-name + (princ (substitute-command-keys "Defined in `")) + (princ (file-name-nondirectory file-name)) + (princ (substitute-command-keys "'")) + ;; Make a hyperlink to the library. + (save-excursion + (re-search-backward + (substitute-command-keys "`\\([^`']+\\)'") nil t) + (help-xref-button 1 'help-face-def f file-name)) + (princ ".") + (terpri) + (terpri)))) + (terpri) + (run-hook-with-args 'help-fns-describe-face-functions f frame)))))) + +(add-hook 'help-fns-describe-face-functions + #'help-fns--face-custom-version-info) +(defun help-fns--face-custom-version-info (face _frame) + (when-let ((version-info (describe-variable-custom-version-info face 'face))) + (insert version-info) + (terpri))) + +(add-hook 'help-fns-describe-face-functions #'help-fns--face-attributes) +(defun help-fns--face-attributes (face frame) + (let* ((attrs '((:family . "Family") + (:foundry . "Foundry") + (:width . "Width") + (:height . "Height") + (:weight . "Weight") + (:slant . "Slant") + (:foreground . "Foreground") + (:distant-foreground . "DistantForeground") + (:background . "Background") + (:underline . "Underline") + (:overline . "Overline") + (:strike-through . "Strike-through") + (:box . "Box") + (:inverse-video . "Inverse") + (:stipple . "Stipple") + (:font . "Font") + (:fontset . "Fontset") + (:inherit . "Inherit"))) + (max-width (apply #'max (mapcar #'(lambda (x) (length (cdr x))) + attrs)))) + (dolist (a attrs) + (let ((attr (face-attribute face (car a) frame))) + (insert (make-string (- max-width (length (cdr a))) ?\s) + (cdr a) ": " (format "%s" attr)) + (if (and (eq (car a) :inherit) + (not (eq attr 'unspecified))) + ;; Make a hyperlink to the parent face. + (save-excursion + (re-search-backward ": \\([^:]+\\)" nil t) + (help-xref-button 1 'help-face attr))) + (insert "\n"))) + (terpri))) + (defvar help-xref-stack-item) ;;;###autoload commit 11432322650830fe9ae365f4113733a79226056d Author: Juanma Barranquero Date: Sat Sep 21 00:27:53 2019 +0200 lisp/*.el: Fix typos and other trivial doc fixes * lisp/allout-widgets.el (allout-widgets-auto-activation) (allout-current-decorated-p): * lisp/auth-source.el (auth-source-protocols): * lisp/autorevert.el (auto-revert-set-timer): * lisp/battery.el (battery-mode-line-limit): * lisp/calc/calcalg3.el (math-map-binop): * lisp/calendar/cal-dst.el (calendar-dst-find-startend): * lisp/calendar/cal-mayan.el (calendar-mayan-long-count-to-absolute): * lisp/calendar/calendar.el (calendar-date-echo-text) (calendar-generate-month, calendar-string-spread) (calendar-cursor-to-date, calendar-read, calendar-read-date) (calendar-mark-visible-date, calendar-dayname-on-or-before): * lisp/calendar/diary-lib.el (diary-ordinal-suffix): * lisp/cedet/ede/autoconf-edit.el (autoconf-new-program) (autoconf-find-last-macro, autoconf-parameter-strip): * lisp/cedet/ede/config.el (ede-target-with-config-build): * lisp/cedet/ede/linux.el (ede-linux--detect-architecture) (ede-linux--get-architecture): * lisp/cedet/semantic/complete.el (semantic-collector-calculate-cache) (semantic-displayer-abstract, semantic-displayer-point-position): * lisp/cedet/semantic/format.el (semantic-format-face-alist) (semantic-format-tag-short-doc): * lisp/cedet/semantic/fw.el (semantic-find-file-noselect): * lisp/cedet/semantic/idle.el (semantic-idle-scheduler-work-idle-time) (semantic-idle-breadcrumbs-display-function) (semantic-idle-breadcrumbs-format-tag-list-function): * lisp/cedet/semantic/lex.el (semantic-lex-map-types) (define-lex, define-lex-block-type-analyzer): * lisp/cedet/semantic/senator.el (senator-search-default-tag-filter): * lisp/cedet/semantic/symref.el (semantic-symref-result) (semantic-symref-hit-to-tag-via-db): * lisp/cedet/semantic/symref.el (semantic-symref-tool-baseclass): * lisp/cedet/semantic/tag.el (semantic-tag-new-variable) (semantic-tag-new-include, semantic-tag-new-package) (semantic-tag-set-faux, semantic-create-tag-proxy) (semantic-tag-function-parent) (semantic-tag-components-with-overlays): * lisp/cedet/srecode/cpp.el (srecode-cpp-namespaces) (srecode-semantic-handle-:c, srecode-semantic-apply-tag-to-dict): * lisp/cedet/srecode/dictionary.el (srecode-create-dictionary) (srecode-dictionary-add-entries, srecode-dictionary-lookup-name) (srecode-create-dictionaries-from-tags): * lisp/cmuscheme.el (scheme-compile-region): * lisp/color.el (color-lab-to-lch): * lisp/doc-view.el (doc-view-image-width) (doc-view-set-up-single-converter): * lisp/dynamic-setting.el (font-setting-change-default-font) (dynamic-setting-handle-config-changed-event): * lisp/elec-pair.el (electric-pair-text-pairs) (electric-pair-skip-whitespace-function) (electric-pair-string-bound-function): * lisp/emacs-lisp/avl-tree.el (avl-tree--del-balance) (avl-tree-member, avl-tree-mapcar, avl-tree-iter): * lisp/emacs-lisp/bytecomp.el (byte-compile-generate-call-tree): * lisp/emacs-lisp/checkdoc.el (checkdoc-autofix-flag) (checkdoc-spellcheck-documentation-flag, checkdoc-ispell) (checkdoc-ispell-current-buffer, checkdoc-ispell-interactive) (checkdoc-ispell-message-interactive) (checkdoc-ispell-message-text, checkdoc-ispell-start) (checkdoc-ispell-continue, checkdoc-ispell-comments) (checkdoc-ispell-defun): * lisp/emacs-lisp/cl-generic.el (cl--generic-search-method): * lisp/emacs-lisp/eieio-custom.el (eieio-read-customization-group): * lisp/emacs-lisp/lisp.el (forward-sexp, up-list): * lisp/emacs-lisp/package-x.el (package--archive-contents-from-file): * lisp/emacs-lisp/package.el (package-desc) (package--make-autoloads-and-stuff, package-hidden-regexps): * lisp/emacs-lisp/tcover-ses.el (ses-exercise-startup): * lisp/emacs-lisp/testcover.el (testcover-nohits) (testcover-1value): * lisp/epg.el (epg-receive-keys, epg-start-edit-key): * lisp/erc/erc-backend.el (erc-server-processing-p) (erc-split-line-length, erc-server-coding-system) (erc-server-send, erc-message): * lisp/erc/erc-button.el (erc-button-face, erc-button-alist) (erc-browse-emacswiki): * lisp/erc/erc-ezbounce.el (erc-ezbounce, erc-ezb-get-login): * lisp/erc/erc-fill.el (erc-fill-variable-maximum-indentation): * lisp/erc/erc-log.el (erc-current-logfile): * lisp/erc/erc-match.el (erc-log-match-format) (erc-text-matched-hook): * lisp/erc/erc-netsplit.el (erc-netsplit, erc-netsplit-debug): * lisp/erc/erc-networks.el (erc-server-alist) (erc-networks-alist, erc-current-network): * lisp/erc/erc-ring.el (erc-input-ring-index): * lisp/erc/erc-speedbar.el (erc-speedbar) (erc-speedbar-update-channel): * lisp/erc/erc-stamp.el (erc-timestamp-only-if-changed-flag): * lisp/erc/erc-track.el (erc-track-position-in-mode-line) (erc-track-remove-from-mode-line, erc-modified-channels-update) (erc-track-last-non-erc-buffer, erc-track-sort-by-importance) (erc-track-get-active-buffer): * lisp/erc/erc.el (erc-get-channel-user-list) (erc-echo-notice-hook, erc-echo-notice-always-hook) (erc-wash-quit-reason, erc-format-@nick): * lisp/ffap.el (ffap-latex-mode): * lisp/files.el (abort-if-file-too-large) (dir-locals--get-sort-score, buffer-stale--default-function): * lisp/filesets.el (filesets-tree-max-level, filesets-data) (filesets-update-pre010505): * lisp/gnus/gnus-agent.el (gnus-agent-flush-cache): * lisp/gnus/gnus-art.el (gnus-article-encrypt-protocol) (gnus-button-prefer-mid-or-mail): * lisp/gnus/gnus-cus.el (gnus-group-parameters): * lisp/gnus/gnus-demon.el (gnus-demon-handlers) (gnus-demon-run-callback): * lisp/gnus/gnus-dired.el (gnus-dired-print): * lisp/gnus/gnus-icalendar.el (gnus-icalendar-event-from-buffer): * lisp/gnus/gnus-range.el (gnus-range-normalize): * lisp/gnus/gnus-spec.el (gnus-pad-form): * lisp/gnus/gnus-srvr.el (gnus-server-agent, gnus-server-cloud) (gnus-server-opened, gnus-server-closed, gnus-server-denied) (gnus-server-offline): * lisp/gnus/gnus-sum.el (gnus-refer-thread-use-nnir) (gnus-refer-thread-limit-to-thread) (gnus-summary-limit-include-thread, gnus-summary-refer-thread) (gnus-summary-find-matching): * lisp/gnus/gnus-util.el (gnus-rescale-image): * lisp/gnus/gnus.el (gnus-summary-line-format, gnus-no-server): * lisp/gnus/mail-source.el (mail-source-incoming-file-prefix): * lisp/gnus/message.el (message-cite-reply-position) (message-cite-style-outlook, message-cite-style-thunderbird) (message-cite-style-gmail, message--send-mail-maybe-partially): * lisp/gnus/mm-extern.el (mm-inline-external-body): * lisp/gnus/mm-partial.el (mm-inline-partial): * lisp/gnus/mml-sec.el (mml-secure-message-sign) (mml-secure-message-sign-encrypt, mml-secure-message-encrypt): * lisp/gnus/mml2015.el (mml2015-epg-key-image) (mml2015-epg-key-image-to-string): * lisp/gnus/nndiary.el (nndiary-reminders, nndiary-get-new-mail): * lisp/gnus/nnheader.el (nnheader-directory-files-is-safe): * lisp/gnus/nnir.el (nnir-search-history) (nnir-imap-search-other, nnir-artlist-length) (nnir-artlist-article, nnir-artitem-group, nnir-artitem-number) (nnir-artitem-rsv, nnir-article-group, nnir-article-number) (nnir-article-rsv, nnir-article-ids, nnir-categorize) (nnir-retrieve-headers-override-function) (nnir-imap-default-search-key, nnir-hyrex-additional-switches) (gnus-group-make-nnir-group, nnir-run-namazu, nnir-read-parms) (nnir-read-parm, nnir-read-server-parm, nnir-search-thread): * lisp/gnus/nnmairix.el (nnmairix-default-group) (nnmairix-propagate-marks): * lisp/gnus/smime.el (smime-keys, smime-crl-check) (smime-verify-buffer, smime-noverify-buffer): * lisp/gnus/spam-report.el (spam-report-url-ping-mm-url): * lisp/gnus/spam.el (spam-spamassassin-positive-spam-flag-header) (spam-spamassassin-spam-status-header, spam-sa-learn-rebuild) (spam-classifications, spam-check-stat, spam-spamassassin-score): * lisp/help.el (describe-minor-mode-from-symbol): * lisp/hippie-exp.el (hippie-expand-ignore-buffers): * lisp/htmlfontify.el (hfy-optimizations, hfy-face-resolve-face) (hfy-begin-span): * lisp/ibuf-ext.el (ibuffer-update-saved-filters-format) (ibuffer-saved-filters, ibuffer-old-saved-filters-warning) (ibuffer-filtering-qualifiers, ibuffer-repair-saved-filters) (eval, ibuffer-unary-operand, file-extension, directory): * lisp/image-dired.el (image-dired-cmd-pngcrush-options): * lisp/image-mode.el (image-toggle-display): * lisp/international/ccl.el (ccl-compile-read-multibyte-character) (ccl-compile-write-multibyte-character): * lisp/international/kkc.el (kkc-save-init-file): * lisp/international/latin1-disp.el (latin1-display): * lisp/international/ogonek.el (ogonek-name-encoding-alist) (ogonek-information, ogonek-lookup-encoding) (ogonek-deprefixify-region): * lisp/isearch.el (isearch-filter-predicate) (isearch--momentary-message): * lisp/jsonrpc.el (jsonrpc-connection-send) (jsonrpc-process-connection, jsonrpc-shutdown) (jsonrpc--async-request-1): * lisp/language/tibet-util.el (tibetan-char-p): * lisp/mail/feedmail.el (feedmail-queue-use-send-time-for-date) (feedmail-last-chance-hook, feedmail-before-fcc-hook) (feedmail-send-it-immediately-wrapper, feedmail-find-eoh): * lisp/mail/hashcash.el (hashcash-generate-payment) (hashcash-generate-payment-async, hashcash-insert-payment) (hashcash-verify-payment): * lisp/mail/rmail.el (rmail-movemail-variant-in-use) (rmail-get-attr-value): * lisp/mail/rmailmm.el (rmail-mime-prefer-html, rmail-mime): * lisp/mail/rmailsum.el (rmail-summary-show-message): * lisp/mail/supercite.el (sc-raw-mode-toggle): * lisp/man.el (Man-start-calling): * lisp/mh-e/mh-acros.el (mh-do-at-event-location) (mh-iterate-on-messages-in-region, mh-iterate-on-range): * lisp/mh-e/mh-alias.el (mh-alias-system-aliases) (mh-alias-reload, mh-alias-ali) (mh-alias-canonicalize-suggestion, mh-alias-add-alias-to-file) (mh-alias-add-alias): * lisp/mouse.el (mouse-save-then-kill): * lisp/net/browse-url.el (browse-url-default-macosx-browser): * lisp/net/eudc.el (eudc-set, eudc-variable-protocol-value) (eudc-variable-server-value, eudc-update-variable) (eudc-expand-inline): * lisp/net/eudcb-bbdb.el (eudc-bbdb-format-record-as-result): * lisp/net/eudcb-ldap.el (eudc-ldap-get-field-list): * lisp/net/pop3.el (pop3-list): * lisp/net/soap-client.el (soap-namespace-put) (soap-xs-parse-sequence, soap-parse-envelope): * lisp/net/soap-inspect.el (soap-inspect-xs-complex-type): * lisp/nxml/rng-xsd.el (rng-xsd-date-to-days): * lisp/org/ob-C.el (org-babel-prep-session:C) (org-babel-load-session:C): * lisp/org/ob-J.el (org-babel-execute:J): * lisp/org/ob-asymptote.el (org-babel-prep-session:asymptote): * lisp/org/ob-awk.el (org-babel-execute:awk): * lisp/org/ob-core.el (org-babel-process-file-name): * lisp/org/ob-ebnf.el (org-babel-execute:ebnf): * lisp/org/ob-forth.el (org-babel-execute:forth): * lisp/org/ob-fortran.el (org-babel-execute:fortran) (org-babel-prep-session:fortran, org-babel-load-session:fortran): * lisp/org/ob-groovy.el (org-babel-execute:groovy): * lisp/org/ob-io.el (org-babel-execute:io): * lisp/org/ob-js.el (org-babel-execute:js): * lisp/org/ob-lilypond.el (org-babel-default-header-args:lilypond) (org-babel-lilypond-compile-post-tangle) (org-babel-lilypond-display-pdf-post-tangle) (org-babel-lilypond-tangle) (org-babel-lilypond-execute-tangled-ly) (org-babel-lilypond-compile-lilyfile) (org-babel-lilypond-check-for-compile-error) (org-babel-lilypond-process-compile-error) (org-babel-lilypond-mark-error-line) (org-babel-lilypond-parse-error-line) (org-babel-lilypond-attempt-to-open-pdf) (org-babel-lilypond-attempt-to-play-midi) (org-babel-lilypond-switch-extension) (org-babel-lilypond-set-header-args): * lisp/org/ob-lua.el (org-babel-prep-session:lua): * lisp/org/ob-picolisp.el (org-babel-execute:picolisp): * lisp/org/ob-processing.el (org-babel-prep-session:processing): * lisp/org/ob-python.el (org-babel-prep-session:python): * lisp/org/ob-scheme.el (org-babel-scheme-capture-current-message) (org-babel-scheme-execute-with-geiser, org-babel-execute:scheme): * lisp/org/ob-shen.el (org-babel-execute:shen): * lisp/org/org-agenda.el (org-agenda-entry-types) (org-agenda-move-date-from-past-immediately-to-today) (org-agenda-time-grid, org-agenda-sorting-strategy) (org-agenda-filter-by-category, org-agenda-forward-block): * lisp/org/org-colview.el (org-columns--overlay-text): * lisp/org/org-faces.el (org-verbatim, org-cycle-level-faces): * lisp/org/org-indent.el (org-indent-set-line-properties): * lisp/org/org-macs.el (org-get-limited-outline-regexp): * lisp/org/org-mobile.el (org-mobile-files): * lisp/org/org.el (org-use-fast-todo-selection) (org-extend-today-until, org-use-property-inheritance) (org-refresh-effort-properties, org-open-at-point-global) (org-track-ordered-property-with-tag, org-shiftright): * lisp/org/ox-html.el (org-html-checkbox-type): * lisp/org/ox-man.el (org-man-source-highlight) (org-man-verse-block): * lisp/org/ox-publish.el (org-publish-sitemap-default): * lisp/outline.el (outline-head-from-level): * lisp/progmodes/dcl-mode.el (dcl-back-to-indentation-1) (dcl-calc-command-indent, dcl-indent-to): * lisp/progmodes/flymake.el (flymake-make-diagnostic) (flymake--overlays, flymake-diagnostic-functions) (flymake-diagnostic-types-alist, flymake--backend-state) (flymake-is-running, flymake--collect, flymake-mode): * lisp/progmodes/gdb-mi.el (gdb-threads-list, gdb, gdb-non-stop) (gdb-buffers, gdb-gud-context-call, gdb-jsonify-buffer): * lisp/progmodes/grep.el (grep-error-screen-columns): * lisp/progmodes/gud.el (gud-prev-expr): * lisp/progmodes/ps-mode.el (ps-mode, ps-mode-target-column) (ps-run-goto-error): * lisp/progmodes/python.el (python-eldoc-get-doc) (python-eldoc-function-timeout-permanent, python-eldoc-function): * lisp/shadowfile.el (shadow-make-group): * lisp/speedbar.el (speedbar-obj-do-check): * lisp/textmodes/flyspell.el (flyspell-auto-correct-previous-hook): * lisp/textmodes/reftex-cite.el (reftex-bib-or-thebib): * lisp/textmodes/reftex-index.el (reftex-index-goto-entry) (reftex-index-kill, reftex-index-undo): * lisp/textmodes/reftex-parse.el (reftex-context-substring): * lisp/textmodes/reftex.el (reftex-TeX-master-file): * lisp/textmodes/rst.el (rst-next-hdr, rst-toc) (rst-uncomment-region, rst-font-lock-extend-region-internal): * lisp/thumbs.el (thumbs-mode): * lisp/vc/ediff-util.el (ediff-restore-diff): * lisp/vc/pcvs-defs.el (cvs-cvsroot, cvs-force-dir-tag): * lisp/vc/vc-hg.el (vc-hg--ignore-patterns-valid-p): * lisp/wid-edit.el (widget-field-value-set, string): * lisp/x-dnd.el (x-dnd-version-from-flags) (x-dnd-more-than-3-from-flags): Assorted docfixes. diff --git a/lisp/allout-widgets.el b/lisp/allout-widgets.el index e4a8db8a62..3f5621fa34 100644 --- a/lisp/allout-widgets.el +++ b/lisp/allout-widgets.el @@ -132,7 +132,7 @@ Also enable `allout-auto-activation' for this to take effect upon visiting an outline. When this is set you can disable allout widgets in select files -by setting `allout-widgets-mode-inhibit' +by setting `allout-widgets-mode-inhibit'. Instead of setting `allout-widgets-auto-activation' you can explicitly invoke `allout-widgets-mode' in allout buffers where @@ -867,7 +867,7 @@ Optional RECURSING is for internal use, to limit recursion." ) ;;;_ > allout-current-decorated-p () (defun allout-current-decorated-p () - "True if the current item is not decorated" + "True if the current item is not decorated." (save-excursion (if (allout-back-to-current-heading) (if (> allout-recent-depth 0) diff --git a/lisp/auth-source.el b/lisp/auth-source.el index 464facdeaf..2164a550b0 100644 --- a/lisp/auth-source.el +++ b/lisp/auth-source.el @@ -136,7 +136,7 @@ let-binding." (ssh "ssh" "22") (sftp "sftp" "115") (smtp "smtp" "25")) - "List of authentication protocols and their names" + "List of authentication protocols and their names." :version "23.2" ;; No Gnus :type '(repeat :tag "Authentication Protocols" diff --git a/lisp/autorevert.el b/lisp/autorevert.el index 6cdc1d3a29..9275513c8d 100644 --- a/lisp/autorevert.el +++ b/lisp/autorevert.el @@ -616,7 +616,7 @@ Called after `set-visited-file-name'." If such a timer is active, cancel it. Start a new timer if Global Auto-Revert Mode is active or if Auto-Revert Mode is active in some buffer. Restarting the timer ensures that Auto-Revert Mode -will use an up-to-date value of `auto-revert-interval'" +will use an up-to-date value of `auto-revert-interval'." (interactive) (if (timerp auto-revert-timer) (cancel-timer auto-revert-timer)) diff --git a/lisp/battery.el b/lisp/battery.el index 0ef6d37b40..2319ce73bb 100644 --- a/lisp/battery.el +++ b/lisp/battery.el @@ -113,7 +113,7 @@ string are substituted as defined by the current value of the variable ;;;###autoload (put 'battery-mode-line-string 'risky-local-variable t) (defcustom battery-mode-line-limit 100 - "Percentage of full battery load below which display battery status" + "Percentage of full battery load below which display battery status." :version "24.1" :type 'integer :group 'battery) diff --git a/lisp/calc/calcalg3.el b/lisp/calc/calcalg3.el index 8015b8ed7c..229edc77c7 100644 --- a/lisp/calc/calcalg3.el +++ b/lisp/calc/calcalg3.el @@ -40,7 +40,7 @@ (defun math-map-binop (binop args1 args2) - "Apply BINOP to the elements of the lists ARGS1 and ARGS2" + "Apply BINOP to the elements of the lists ARGS1 and ARGS2." (if args1 (cons (funcall binop (car args1) (car args2)) diff --git a/lisp/calendar/cal-dst.el b/lisp/calendar/cal-dst.el index 2d3b1f8c81..355f72cd15 100644 --- a/lisp/calendar/cal-dst.el +++ b/lisp/calendar/cal-dst.el @@ -276,7 +276,7 @@ function `calendar-dst-find-startend'.") "Find the dates in YEAR on which daylight saving time starts and ends. Returns a list (YEAR START END), where START and END are expressions that when evaluated return the start and end dates, -respectively. This function first attempts to use pre-calculated +respectively. This function first attempts to use pre-calculated data from `calendar-dst-transition-cache', otherwise it calls `calendar-dst-find-data' (and adds the results to the cache). If dates in YEAR cannot be handled by `encode-time' (e.g., diff --git a/lisp/calendar/cal-mayan.el b/lisp/calendar/cal-mayan.el index cda2c888f2..1ac0ac750a 100644 --- a/lisp/calendar/cal-mayan.el +++ b/lisp/calendar/cal-mayan.el @@ -314,7 +314,7 @@ Echo Mayan date unless NOECHO is non-nil." (defun calendar-mayan-long-count-to-absolute (c) "Compute the absolute date corresponding to the Mayan Long Count C. -Long count is a list (baktun katun tun uinal kin)" +Long count is a list (baktun katun tun uinal kin)." (+ (* (nth 0 c) 144000) ; baktun (* (nth 1 c) 7200) ; katun (* (nth 2 c) 360) ; tun diff --git a/lisp/calendar/calendar.el b/lisp/calendar/calendar.el index e7a7bd47d6..43a8e8e38d 100644 --- a/lisp/calendar/calendar.el +++ b/lisp/calendar/calendar.el @@ -409,6 +409,7 @@ display the ISO date: (setq calendar-date-echo-text \\='(format \"ISO date: %s\" (calendar-iso-date-string (list month day year)))) + Changing this variable without using customize has no effect on pre-existing calendar windows." :group 'calendar @@ -1471,10 +1472,10 @@ STRING to length TRUNCATE, and ensures a trailing space." (defun calendar-generate-month (month year indent) "Produce a calendar for MONTH, YEAR on the Gregorian calendar. -The calendar is inserted at the top of the buffer in which point is currently -located, but indented INDENT spaces. The indentation is done from the first -character on the line and does not disturb the first INDENT characters on the -line." +The calendar is inserted at the top of the buffer in which point is +currently located, but indented INDENT spaces. The indentation is +done from the first character on the line and does not disturb the +first INDENT characters on the line." (let ((blank-days ; at start of month (mod (- (calendar-day-of-week (list month 1 year)) @@ -1792,10 +1793,11 @@ For a complete description, see the info node `Calendar/Diary'. (defun calendar-string-spread (strings char length) "Concatenate list of STRINGS separated with copies of CHAR to fill LENGTH. -The effect is like `mapconcat' but the separating pieces are as balanced as -possible. Each item of STRINGS is evaluated before concatenation so it can -actually be an expression that evaluates to a string. If LENGTH is too short, -the STRINGS are just concatenated and the result truncated." +The effect is like `mapconcat' but the separating pieces are as +balanced as possible. Each item of STRINGS is evaluated before +concatenation so it can actually be an expression that evaluates +to a string. If LENGTH is too short, the STRINGS are just +concatenated and the result truncated." ;; The algorithm is based on equation (3.25) on page 85 of Concrete ;; Mathematics by Ronald L. Graham, Donald E. Knuth, and Oren Patashnik, ;; Addison-Wesley, Reading, MA, 1989. @@ -1889,8 +1891,8 @@ The left-most month returns 0, the next right 1, and so on." (defun calendar-cursor-to-date (&optional error event) "Return a list (month day year) of current cursor position. -If cursor is not on a specific date, signals an error if optional parameter -ERROR is non-nil, otherwise just returns nil. +If cursor is not on a specific date, signals an error if optional +parameter ERROR is non-nil, otherwise just returns nil. If EVENT is non-nil, it's an event indicating the buffer position to use instead of point." (with-current-buffer @@ -2046,9 +2048,9 @@ With argument ARG, jump to mark, pop it, and put point at end of ring." (defun calendar-read (prompt acceptable &optional initial-contents) "Return an object read from the minibuffer. -Prompt with the string PROMPT and use the function ACCEPTABLE to decide if -entered item is acceptable. If non-nil, optional third arg INITIAL-CONTENTS -is a string to insert in the minibuffer before reading." +Prompt with the string PROMPT and use the function ACCEPTABLE to decide +if entered item is acceptable. If non-nil, optional third arg +INITIAL-CONTENTS is a string to insert in the minibuffer before reading." (let ((value (read-minibuffer prompt initial-contents))) (while (not (funcall acceptable value)) (setq value (read-minibuffer prompt initial-contents))) @@ -2277,8 +2279,8 @@ arguments SEQUENCES." (defun calendar-read-date (&optional noday) "Prompt for Gregorian date. Return a list (month day year). If optional NODAY is t, does not ask for day, but just returns -\(month 1 year); if NODAY is any other non-nil value the value returned is -\(month year)" +\(month 1 year); if NODAY is any other non-nil value the value +returned is (month year)." (let* ((year (calendar-read "Year (>0): " (lambda (x) (> x 0)) @@ -2458,8 +2460,8 @@ ATTRLIST is a list with elements of the form :face face :foreground color." (defun calendar-mark-visible-date (date &optional mark) "Mark DATE in the calendar window with MARK. -MARK is a single-character string, a list of face attributes/values, or a face. -MARK defaults to `diary-entry-marker'." +MARK is a single-character string, a list of face attributes/values, +or a face. MARK defaults to `diary-entry-marker'." (if (calendar-date-is-valid-p date) (with-current-buffer calendar-buffer (save-excursion @@ -2538,10 +2540,11 @@ name of the day of the week." "Return the absolute date of the DAYNAME on or before absolute DATE. DAYNAME=0 means Sunday, DAYNAME=1 means Monday, and so on. -Note: Applying this function to d+6 gives us the DAYNAME on or after an -absolute day d. Similarly, applying it to d+3 gives the DAYNAME nearest to -absolute date d, applying it to d-1 gives the DAYNAME previous to absolute -date d, and applying it to d+7 gives the DAYNAME following absolute date d." +Note: Applying this function to d+6 gives us the DAYNAME on or after +an absolute day d. Similarly, applying it to d+3 gives the DAYNAME +nearest to absolute date d, applying it to d-1 gives the DAYNAME +previous to absolute date d, and applying it to d+7 gives the DAYNAME +following absolute date d." (- date (% (- date dayname) 7))) (defun calendar-nth-named-absday (n dayname month year &optional day) diff --git a/lisp/calendar/diary-lib.el b/lisp/calendar/diary-lib.el index 5a2374a595..d783f11e35 100644 --- a/lisp/calendar/diary-lib.el +++ b/lisp/calendar/diary-lib.el @@ -1950,7 +1950,7 @@ highlighting the day in the calendar." (cons mark entry))))) (defun diary-ordinal-suffix (n) - "Ordinal suffix for N. (That is, `st', `nd', `rd', or `th', as appropriate.)" + "Ordinal suffix for N. (That is, `st', `nd', `rd', or `th', as appropriate.)" (if (or (memq (% n 100) '(11 12 13)) (< 3 (% n 10))) "th" diff --git a/lisp/cedet/ede/autoconf-edit.el b/lisp/cedet/ede/autoconf-edit.el index c243e9bf6d..8918b4eb62 100644 --- a/lisp/cedet/ede/autoconf-edit.el +++ b/lisp/cedet/ede/autoconf-edit.el @@ -35,7 +35,7 @@ ROOTDIR is the root directory of a given autoconf controlled project. PROGRAM is the program to be configured. TESTFILE is the file used with AC_INIT. -configure the initial configure script using `autoconf-new-automake-string'" +Configure the initial configure script using `autoconf-new-automake-string'." (interactive "DRoot Dir: \nsProgram: \nsTest File: ") (require 'ede/srecode) (if (bufferp rootdir) @@ -147,7 +147,7 @@ From the autoconf manual: (looking-at (concat "\\(A[CM]_" macro "\\|" macro "\\)")))) (defun autoconf-find-last-macro (macro &optional ignore-bol) - "Move to the last occurrence of MACRO in FILE, and return that point. + "Move to the last occurrence of MACRO, and return that point. The last macro is usually the one in which we would like to insert more items such as CHECK_HEADERS." (let ((op (point)) (atbol (if ignore-bol "" "^"))) @@ -160,7 +160,7 @@ items such as CHECK_HEADERS." nil))) (defun autoconf-parameter-strip (param) - "Strip the parameter PARAM of whitespace and miscellaneous characters." + "Strip the parameter PARAM of whitespace and miscellaneous characters." ;; force greedy match for \n. (when (string-match "\\`\n*\\s-*\\[?\\s-*" param) (setq param (substring param (match-end 0)))) diff --git a/lisp/cedet/ede/config.el b/lisp/cedet/ede/config.el index c8bf7f33ba..39d984ac35 100644 --- a/lisp/cedet/ede/config.el +++ b/lisp/cedet/ede/config.el @@ -300,7 +300,7 @@ This class brings in method overloads for building.") (defclass ede-target-with-config-build () () "Class to mix into a project with configuration for builds. -This class brings in method overloads for for building.") +This class brings in method overloads for building.") (cl-defmethod project-compile-project ((proj ede-project-with-config-build) &optional command) "Compile the entire current project PROJ. diff --git a/lisp/cedet/ede/linux.el b/lisp/cedet/ede/linux.el index 424a20dec4..b5a6482bbd 100644 --- a/lisp/cedet/ede/linux.el +++ b/lisp/cedet/ede/linux.el @@ -136,7 +136,7 @@ If DIR has not been used as a build directory, fall back to (defun ede-linux--detect-architecture (dir) "Try to auto-detect the architecture as configured in DIR. -DIR is Linux' build directory. If it cannot be auto-detected, +DIR is Linux' build directory. If it cannot be auto-detected, returns `project-linux-architecture-default'." (let ((archs-dir (expand-file-name "arch" dir)) (archs (ede-linux--get-archs dir)) @@ -157,9 +157,9 @@ returns `project-linux-architecture-default'." (defun ede-linux--get-architecture (dir bdir) "Try to auto-detect the architecture as configured in BDIR. -Uses `ede-linux--detect-architecture' for the auto-detection. If -the result is `ask', let the user choose from architectures found -in DIR." +Uses `ede-linux--detect-architecture' for the auto-detection. +If the result is `ask', let the user choose from architectures +found in DIR." (let ((arch (ede-linux--detect-architecture bdir))) (cl-case arch (ask diff --git a/lisp/cedet/semantic/complete.el b/lisp/cedet/semantic/complete.el index 8f89d1a51e..14d2bd38ee 100644 --- a/lisp/cedet/semantic/complete.el +++ b/lisp/cedet/semantic/complete.el @@ -1219,7 +1219,7 @@ Basics search only in the current buffer.") (cl-defmethod semantic-collector-calculate-cache ((obj semantic-collector-buffer-deep)) "Calculate the completion cache for OBJ. -Uses `semantic-flatten-tags-table'" +Uses `semantic-flatten-tags-table'." (oset obj cache ;; Must create it in SEMANTICDB find format. ;; ( ( DBTABLE TAG TAG ... ) ... ) @@ -1314,7 +1314,7 @@ Uses semanticdb for searching all tags in the current project." :documentation "List of tags this displayer is showing.") (last-prefix :type string :protection :protected - :documentation "Prefix associated with slot `table'") + :documentation "Prefix associated with slot `table'.") ) "Abstract displayer baseclass. Manages the display of some number of tags. @@ -1746,7 +1746,7 @@ Display mechanism using tooltip for a list of possible completions.") (defun semantic-displayer-point-position () "Return the location of POINT as positioned on the selected frame. -Return a cons cell (X . Y)" +Return a cons cell (X . Y)." (let* ((frame (selected-frame)) (toolbarleft (if (eq (cdr (assoc 'tool-bar-position default-frame-alist)) 'left) diff --git a/lisp/cedet/semantic/format.el b/lisp/cedet/semantic/format.el index b576ad5e21..00f684276b 100644 --- a/lisp/cedet/semantic/format.el +++ b/lisp/cedet/semantic/format.el @@ -107,7 +107,7 @@ Override the value locally if a language supports other tag types. When adding new elements, try to use symbols also returned by the parser. The form of an entry in this list is of the form: ( SYMBOL . FACE ) -where SYMBOL is a tag type symbol used with semantic. FACE +where SYMBOL is a tag type symbol used with semantic, and FACE is a symbol representing a face. Faces used are generated in `font-lock' for consistency, and will not be used unless font lock is a feature.") @@ -407,7 +407,7 @@ Optional argument COLOR means highlight the prototype with font-lock colors." (concat file ": " proto)))) (define-overloadable-function semantic-format-tag-short-doc (tag &optional parent color) - "Display a short form of TAG's documentation. (Comments, or docstring.) + "Display a short form of TAG's documentation. (Comments, or docstring.) Optional argument PARENT is the parent type if TAG is a detail. Optional argument COLOR means highlight the prototype with font-lock colors.") diff --git a/lisp/cedet/semantic/fw.el b/lisp/cedet/semantic/fw.el index 0dd0a93218..216a47547d 100644 --- a/lisp/cedet/semantic/fw.el +++ b/lisp/cedet/semantic/fw.el @@ -329,7 +329,7 @@ calling this one." (defun semantic-find-file-noselect (file &optional nowarn rawfile wildcards) "Call `find-file-noselect' with various features turned off. Use this when referencing a file that will be soon deleted. -FILE, NOWARN, RAWFILE, and WILDCARDS are passed into `find-file-noselect'" +FILE, NOWARN, RAWFILE, and WILDCARDS are passed into `find-file-noselect'." ;; Hack - ;; Check if we are in set-auto-mode, and if so, warn about this. (when (boundp 'keep-mode-if-same) diff --git a/lisp/cedet/semantic/idle.el b/lisp/cedet/semantic/idle.el index 09af66658f..35ec930469 100644 --- a/lisp/cedet/semantic/idle.el +++ b/lisp/cedet/semantic/idle.el @@ -91,8 +91,8 @@ run as soon as Emacs is idle." (defcustom semantic-idle-scheduler-work-idle-time 60 "Time in seconds of idle before scheduling big work. -This time should be long enough that once any big work is started, it is -unlikely the user would be ready to type again right away." +This time should be long enough that once any big work is started, +it is unlikely the user would be ready to type again right away." :group 'semantic :type 'number :set (lambda (sym val) @@ -1004,8 +1004,8 @@ completion. #'semantic-idle-breadcrumbs--display-in-header-line "Function to display the tag under point in idle time. This function should take a list of Semantic tags as its only -argument. The tags are sorted according to their nesting order, -starting with the outermost tag. The function should call +argument. The tags are sorted according to their nesting order, +starting with the outermost tag. The function should call `semantic-idle-breadcrumbs-format-tag-list-function' to convert the tag list into a string." :group 'semantic @@ -1020,13 +1020,13 @@ the tag list into a string." #'semantic-idle-breadcrumbs--format-linear "Function to format the list of tags containing point. This function should take a list of Semantic tags and an optional -maximum length of the produced string as its arguments. The -maximum length is a hint and can be ignored. When the maximum -length is omitted, an unconstrained string should be -produced. The tags are sorted according to their nesting order, -starting with the outermost tag. Single tags should be formatted -using `semantic-idle-breadcrumbs-format-tag-function' unless -special formatting is required." +maximum length of the produced string as its arguments. The +maximum length is a hint and can be ignored. When the maximum +length is omitted, an unconstrained string should be produced. +The tags are sorted according to their nesting order, starting +with the outermost tag. Single tags should be formatted using +`semantic-idle-breadcrumbs-format-tag-function' unless special +formatting is required." :group 'semantic :type '(choice (const :tag "Format tags as list, innermost last" diff --git a/lisp/cedet/semantic/lex.el b/lisp/cedet/semantic/lex.el index 50e09e2359..5df92f5317 100644 --- a/lisp/cedet/semantic/lex.el +++ b/lisp/cedet/semantic/lex.el @@ -454,7 +454,7 @@ PROPSPECS must be a list of (TYPE PROPERTY VALUE)." (defsubst semantic-lex-map-types (fun &optional property) "Call function FUN on every lexical type. If optional PROPERTY is non-nil, call FUN only on every type symbol -which as a PROPERTY value. FUN receives a type symbol as argument." +which has a PROPERTY value. FUN receives a type symbol as argument." (semantic-lex-map-symbols fun semantic-lex-types-obarray property)) @@ -769,7 +769,7 @@ Note: The order in which analyzers are listed is important. If two analyzers can match the same text, it is important to order the analyzers so that the one you want to match first occurs first. For example, it is good to put a number analyzer in front of a symbol -analyzer which might mistake a number for as a symbol." +analyzer which might mistake a number for a symbol." `(defun ,name (start end &optional depth length) ,(concat doc "\nSee `semantic-lex' for more information.") ;; Make sure the state of block parsing starts over. @@ -1581,7 +1581,7 @@ DEFAULT is the default lexical token returned when no MATCHES." (defmacro define-lex-block-type-analyzer (name doc syntax matches) "Define a block type analyzer NAME with DOC string. -SYNTAX is the regexp that matches block delimiters, typically the +SYNTAX is the regexp that matches block delimiters, typically the open (`\\\\s(') and close (`\\\\s)') parenthesis syntax classes. MATCHES is a pair (OPEN-SPECS . CLOSE-SPECS) that defines blocks. diff --git a/lisp/cedet/semantic/senator.el b/lisp/cedet/semantic/senator.el index f76d332888..714190133f 100644 --- a/lisp/cedet/semantic/senator.el +++ b/lisp/cedet/semantic/senator.el @@ -198,7 +198,7 @@ Tags of those classes are excluded from search." (defun senator-search-default-tag-filter (tag) "Default function that filters searched tags. -Ignore tags of classes in `senator-search-ignore-tag-classes'" +Ignore tags of classes in `senator-search-ignore-tag-classes'." (not (memq (semantic-tag-class tag) senator-search-ignore-tag-classes))) diff --git a/lisp/cedet/semantic/symref.el b/lisp/cedet/semantic/symref.el index 00403d4d52..85acd50712 100644 --- a/lisp/cedet/semantic/symref.el +++ b/lisp/cedet/semantic/symref.el @@ -319,7 +319,7 @@ where different symbols are used. Subclasses should be named `semantic-symref-tool-NAME', where NAME is the name of the tool used in the configuration variable -`semantic-symref-tool'" +`semantic-symref-tool'." :abstract t) (cl-defmethod semantic-symref-get-result ((tool semantic-symref-tool-baseclass)) @@ -388,7 +388,7 @@ Each element is a cons cell of the form (LINE . FILENAME).") :type list :documentation "The list of tags with hits in them. -Use the `semantic-symref-hit-tags' method to get this list.") +Use the `semantic-symref-hit-tags' method to get this list.") ) "The results from a symbol reference search.") @@ -476,7 +476,7 @@ Return the Semantic tag associated with HIT. SEARCHTXT is the text that is being searched for. Used to narrow the in-buffer search. SEARCHTYPE is the type of search (such as 'symbol or 'tagname). -If there is no database, of if the searchtype is wrong, return nil." +If there is no database, or if the searchtype is wrong, return nil." ;; Allowed search types for this mechanism: ;; tagname, tagregexp, tagcompletions (if (not (memq searchtype '(tagname tagregexp tagcompletions))) diff --git a/lisp/cedet/semantic/tag.el b/lisp/cedet/semantic/tag.el index ec8a800ec4..16dda48dc6 100644 --- a/lisp/cedet/semantic/tag.el +++ b/lisp/cedet/semantic/tag.el @@ -471,8 +471,8 @@ ATTRIBUTES is a list of additional attributes belonging to this tag." NAME is the name of this variable. TYPE is a string or semantic tag representing the type of this variable. Optional DEFAULT-VALUE is a string representing the default value of this -variable. ATTRIBUTES is a list of additional attributes belonging to this -tag." +variable. +ATTRIBUTES is a list of additional attributes belonging to this tag." (apply 'semantic-tag name 'variable :type type :default-value default-value @@ -518,8 +518,8 @@ ATTRIBUTES is a list of additional attributes belonging to this tag." (defsubst semantic-tag-new-include (name system-flag &rest attributes) "Create a semantic tag of class `include'. NAME is the name of this include. -SYSTEM-FLAG represents that we were able to identify this include as belonging -to the system, as opposed to belonging to the local project. +SYSTEM-FLAG represents that we were able to identify this include as +belonging to the system, as opposed to belonging to the local project. ATTRIBUTES is a list of additional attributes belonging to this tag." (apply 'semantic-tag name 'include :system-flag system-flag @@ -528,8 +528,8 @@ ATTRIBUTES is a list of additional attributes belonging to this tag." (defsubst semantic-tag-new-package (name detail &rest attributes) "Create a semantic tag of class `package'. NAME is the name of this package. -DETAIL is extra information about this package, such as a location where -it can be found. +DETAIL is extra information about this package, such as a location +where it can be found. ATTRIBUTES is a list of additional attributes belonging to this tag." (apply 'semantic-tag name 'package :detail detail @@ -547,7 +547,7 @@ ATTRIBUTES is a list of additional attributes belonging to this tag." (defsubst semantic-tag-set-faux (tag) "Set TAG to be a new FAUX tag. FAUX tags represent constructs not found in the source code. -You can identify a faux tag with `semantic-tag-faux-p'" +You can identify a faux tag with `semantic-tag-faux-p'." (semantic--tag-put-property tag :faux-flag t)) (defsubst semantic-tag-set-name (tag name) @@ -565,9 +565,9 @@ You can identify a faux tag with `semantic-tag-faux-p'" ;; it. This prevents saving of massive amounts of proxy data. (defun semantic-create-tag-proxy (function data) "Create a tag proxy symbol. -FUNCTION will be used to resolve the proxy. It should take 3 +FUNCTION will be used to resolve the proxy. It should take two arguments, DATA and TAG. TAG is a proxy tag that needs -to be resolved, and DATA is the DATA passed into this function. +to be resolved, and DATA is the data passed into this function. DATA is data to help resolve the proxy. DATA can be an EIEIO object, such that FUNCTION is a method. FUNCTION should return a list of tags, preferably one tag." @@ -870,7 +870,7 @@ That is the value of the `:throws' attribute." "Return the parent of the function that TAG describes. That is the value of the `:parent' attribute. A function has a parent if it is a method of a class, and if the -function does not appear in body of its parent class." +function does not appear in the body of its parent class." (semantic-tag-named-parent tag)) (defsubst semantic-tag-function-destructor-p (tag) @@ -976,7 +976,7 @@ Perform the described task in `semantic-tag-components'." Children are any sub-tags which contain overlays. Default behavior is to get `semantic-tag-components' in addition -to the components of an anonymous types (if applicable.) +to the components of an anonymous type (if applicable.) Note for language authors: If a mode defines a language tag that has tags in it with overlays diff --git a/lisp/cedet/srecode/cpp.el b/lisp/cedet/srecode/cpp.el index 306c60f1b6..9d30b163ee 100644 --- a/lisp/cedet/srecode/cpp.el +++ b/lisp/cedet/srecode/cpp.el @@ -43,7 +43,7 @@ "List expansion candidates for the :using-namespaces argument. A dictionary entry of the named PREFIX_NAMESPACE with the value NAMESPACE:: is created for each namespace unless the current -buffer contains a using NAMESPACE; statement " +buffer contains a using NAMESPACE; statement." :group 'srecode-cpp :type '(repeat string)) @@ -56,7 +56,7 @@ buffer contains a using NAMESPACE; statement " ;;;###autoload (defun srecode-semantic-handle-:c (dict) - "Add macros into the dictionary DICT based on the current c file. + "Add macros into the dictionary DICT based on the current C file. Adds the following: FILENAME_SYMBOL - filename converted into a C compat symbol. HEADER - Shown section if in a header file." @@ -110,7 +110,7 @@ PREFIX_NAMESPACE - for each NAMESPACE in `srecode-cpp-namespaces'." (define-mode-local-override srecode-semantic-apply-tag-to-dict c-mode (tag-wrapper dict) "Apply C and C++ specific features from TAG-WRAPPER into DICT. -Calls `srecode-semantic-apply-tag-to-dict-default' first. Adds +Calls `srecode-semantic-apply-tag-to-dict-default' first. Adds special behavior for tag of classes include, using and function. This function cannot be split into C and C++ specific variants, as diff --git a/lisp/cedet/srecode/dictionary.el b/lisp/cedet/srecode/dictionary.el index 1058024d45..a0205177ca 100644 --- a/lisp/cedet/srecode/dictionary.el +++ b/lisp/cedet/srecode/dictionary.el @@ -147,7 +147,7 @@ Makes sure that :value is compiled." ;; (defun srecode-create-dictionary (&optional buffer-or-parent) - "Create a dictionary for BUFFER. + "Create a dictionary for BUFFER-OR-PARENT. If BUFFER-OR-PARENT is not specified, assume a buffer, and use the current buffer. If BUFFER-OR-PARENT is another dictionary, then remember the @@ -326,8 +326,8 @@ inserted dictionaries." entries &optional state) "Add ENTRIES to DICT. -ENTRIES is a list of even length of dictionary entries to -add. ENTRIES looks like this: +ENTRIES is a list of even length of dictionary entries to add. +ENTRIES looks like this: (NAME_1 VALUE_1 NAME_2 VALUE_2 ...) @@ -340,7 +340,7 @@ and for values * Otherwise, a compound variable is created for VALUE_N. The optional argument STATE has to non-nil when compound values -are inserted. An error is signaled if ENTRIES contains compound +are inserted. An error is signaled if ENTRIES contains compound values but STATE is nil." (while entries (let ((name (nth 0 entries)) @@ -409,8 +409,8 @@ OTHERDICT." name &optional non-recursive) "Return information about DICT's value for NAME. DICT is a dictionary, and NAME is a string that is treated as the -name of an entry in the dictionary. If such an entry exists, its -value is returned. Otherwise, nil is returned. Normally, the +name of an entry in the dictionary. If such an entry exists, its +value is returned. Otherwise, nil is returned. Normally, the lookup is recursive in the sense that the parent of DICT is searched for NAME if it is not found in DICT. This recursive lookup can be disabled by the optional argument NON-RECURSIVE. @@ -552,7 +552,7 @@ inserted with a new editable field.") "Create a dictionary with entries according to TAGS. TAGS should be in the format produced by the template file -grammar. That is +grammar. That is TAGS = (ENTRY_1 ENTRY_2 ...) @@ -560,9 +560,9 @@ where ENTRY_N = (NAME ENTRY_N_1 ENTRY_N_2 ...) | TAG -where TAG is a semantic tag of class 'variable. The (NAME ... ) +where TAG is a semantic tag of class 'variable. The (NAME ... ) form creates a child dictionary which is stored under the name -NAME. The TAG form creates a value entry or section dictionary +NAME. The TAG form creates a value entry or section dictionary entry whose name is the name of the tag. STATE is the current compiler state." diff --git a/lisp/cmuscheme.el b/lisp/cmuscheme.el index ed6f1bfb1a..874cfa98f5 100644 --- a/lisp/cmuscheme.el +++ b/lisp/cmuscheme.el @@ -287,7 +287,7 @@ in this order. Return nil if no start file found." (defun scheme-compile-region (start end) "Compile the current region in the inferior Scheme process. -\(A BEGIN is wrapped around the region: (BEGIN ))" +\(A BEGIN is wrapped around the region: (BEGIN ).)" (interactive "r") (comint-send-string (scheme-proc) (format scheme-compile-exp-command (format "(begin %s)" diff --git a/lisp/color.el b/lisp/color.el index e401456de7..804eb57ee5 100644 --- a/lisp/color.el +++ b/lisp/color.el @@ -291,11 +291,11 @@ conversion. If omitted or nil, use `color-d65-xyz'." (list (/ (* Y x) y) Y (/ (* Y (- 1 x y)) y)))) (defun color-lab-to-lch (L a b) - "Convert CIE L*a*b* to L*C*h*" + "Convert CIE L*a*b* to L*C*h*." (list L (sqrt (+ (* a a) (* b b))) (atan b a))) (defun color-lch-to-lab (L C h) - "Convert CIE L*a*b* to L*C*h*" + "Convert CIE L*a*b* to L*C*h*." (list L (* C (cos h)) (* C (sin h)))) (defun color-cie-de2000 (color1 color2 &optional kL kC kH) diff --git a/lisp/doc-view.el b/lisp/doc-view.el index 78895ebd7a..49d2b56b7d 100644 --- a/lisp/doc-view.el +++ b/lisp/doc-view.el @@ -214,7 +214,7 @@ scaling." (defcustom doc-view-image-width 850 "Default image width. Has only an effect if `doc-view-scale-internally' is non-nil and support for -scaling is compiled into emacs." +scaling is compiled into Emacs." :version "24.1" :type 'number) @@ -1778,7 +1778,7 @@ If BACKWARD is non-nil, jump to the previous match." (error "Cannot determine the document type")))))) (defun doc-view-set-up-single-converter () - "Find the right single-page converter for the current document type" + "Find the right single-page converter for the current document type." (pcase-let ((`(,conv-function ,type ,extension) (pcase doc-view-doc-type ('djvu (list #'doc-view-djvu->tiff-converter-ddjvu 'tiff "tif")) diff --git a/lisp/dynamic-setting.el b/lisp/dynamic-setting.el index cf1a8d3b73..3da8d14cee 100644 --- a/lisp/dynamic-setting.el +++ b/lisp/dynamic-setting.el @@ -40,8 +40,8 @@ "Change font and/or font settings for frames on display DISPLAY-OR-FRAME. If DISPLAY-OR-FRAME is a frame, the display is the one for that frame. -If SET-FONT is non-nil, change the font for frames. Otherwise re-apply the -current form for the frame (i.e. hinting or somesuch changed)." +If SET-FONT is non-nil, change the font for frames. Otherwise re-apply +the current form for the frame (i.e. hinting or somesuch changed)." (let ((new-font (and (fboundp 'font-get-system-font) (font-get-system-font))) (frame-list (frames-on-display-list display-or-frame))) @@ -68,8 +68,8 @@ current form for the frame (i.e. hinting or somesuch changed)." (defun dynamic-setting-handle-config-changed-event (event) "Handle config-changed-event on the display in EVENT. Changes can be - The monospace font. If `font-use-system-font' is nil, the font - is not changed. + The monospace font. If `font-use-system-font' is nil, + the font is not changed. The normal font. Xft parameters, like DPI and hinting. The Gtk+ theme name. diff --git a/lisp/elec-pair.el b/lisp/elec-pair.el index 5fb9d751e2..f3cbee7048 100644 --- a/lisp/elec-pair.el +++ b/lisp/elec-pair.el @@ -51,7 +51,7 @@ See also the variable `electric-pair-text-pairs'." Pairs of delimiters in this list are a fallback in case they have no syntax relevant to `electric-pair-mode' in the syntax table -defined in `electric-pair-text-syntax-table'" +defined in `electric-pair-text-syntax-table'." :version "24.4" :group 'electricity :type '(repeat (cons character character))) @@ -159,7 +159,7 @@ return value is considered instead." #'electric-pair--skip-whitespace "Function to use to skip whitespace forward. Before attempting a skip, if `electric-pair-skip-whitespace' is -non-nil, this function is called. It move point to a new buffer +non-nil, this function is called. It move point to a new buffer position, presumably skipping only whitespace in between.") (defun electric-pair--skip-whitespace () @@ -380,7 +380,7 @@ If point is not enclosed by any lists, return ((t) . (t))." (defvar electric-pair-string-bound-function 'point-max "Next buffer position where strings are syntactically unexpected. Value is a function called with no arguments and returning a -buffer position. Major modes should set this variable +buffer position. Major modes should set this variable buffer-locally if they experience slowness with `electric-pair-mode' when pairing quotes.") diff --git a/lisp/emacs-lisp/avl-tree.el b/lisp/emacs-lisp/avl-tree.el index d2a3a131d1..a586fa0250 100644 --- a/lisp/emacs-lisp/avl-tree.el +++ b/lisp/emacs-lisp/avl-tree.el @@ -130,8 +130,8 @@ NODE is the node, and BRANCH is the branch. (defun avl-tree--del-balance (node branch dir) "Rebalance a tree after deleting a node. -The deletion was done from the left (DIR=0) or right (DIR=1) sub-tree of the -left (BRANCH=0) or right (BRANCH=1) child of NODE. +The deletion was done from the left (DIR=0) or right (DIR=1) sub-tree +of the left (BRANCH=0) or right (BRANCH=1) child of NODE. Return t if the height of the tree has shrunk." ;; (or is it vice-versa for BRANCH?) (let ((br (avl-tree--node-branch node branch)) @@ -477,11 +477,11 @@ value is non-nil." Matching uses the comparison function previously specified in `avl-tree-create' when TREE was created. -If there is no such element in the tree, nil is -returned. Optional argument NILFLAG specifies a value to return -instead of nil in this case. This allows non-existent elements to -be distinguished from a null element. (See also -`avl-tree-member-p', which does this for you.)" +If there is no such element in the tree, nil is returned. +Optional argument NILFLAG specifies a value to return instead of nil +in this case. This allows non-existent elements to be distinguished +from a null element. (See also `avl-tree-member-p', which does this +for you.)" (let ((node (avl-tree--root tree)) (compare-function (avl-tree--cmpfun tree))) (catch 'found @@ -553,13 +553,13 @@ order, or descending order if REVERSE is non-nil." (defun avl-tree-mapcar (fun tree &optional reverse) - "Apply FUNCTION to all elements in AVL tree TREE, + "Apply function FUN to all elements in AVL tree TREE, and make a list of the results. -The FUNCTION is applied and the list constructed in ascending +The function is applied and the list constructed in ascending order, or descending order if REVERSE is non-nil. -Note that if you don't care about the order in which FUNCTION is +Note that if you don't care about the order in which FUN is applied, just that the resulting list is in the correct order, then @@ -674,7 +674,7 @@ a null element stored in the AVL tree.)" "Return an AVL tree iterator object. Calling `iter-next' on this object will retrieve the next element -from TREE. If REVERSE is non-nil, elements are returned in +from TREE. If REVERSE is non-nil, elements are returned in reverse order. Note that any modification to TREE *immediately* invalidates all diff --git a/lisp/emacs-lisp/bytecomp.el b/lisp/emacs-lisp/bytecomp.el index 2fab11c79d..44a65ed4c6 100644 --- a/lisp/emacs-lisp/bytecomp.el +++ b/lisp/emacs-lisp/bytecomp.el @@ -395,16 +395,16 @@ else the global value will be modified." "Non-nil means collect call-graph information when compiling. This records which functions were called and from where. If the value is t, compilation displays the call graph when it finishes. -If the value is neither t nor nil, compilation asks you whether to display -the graph. +If the value is neither t nor nil, compilation asks you whether to +display the graph. -The call tree only lists functions called, not macros used. Those functions -which the byte-code interpreter knows about directly (eq, cons, etc.) are -not reported. +The call tree only lists functions called, not macros used. Those +functions which the byte-code interpreter knows about directly (eq, +cons, etc.) are not reported. -The call tree also lists those functions which are not known to be called -\(that is, to which no calls have been compiled). Functions which can be -invoked interactively are excluded from this list." +The call tree also lists those functions which are not known to be +called (that is, to which no calls have been compiled). Functions +which can be invoked interactively are excluded from this list." :type '(choice (const :tag "Yes" t) (const :tag "No" nil) (other :tag "Ask" lambda))) diff --git a/lisp/emacs-lisp/checkdoc.el b/lisp/emacs-lisp/checkdoc.el index 8a88c5756f..51fb75da69 100644 --- a/lisp/emacs-lisp/checkdoc.el +++ b/lisp/emacs-lisp/checkdoc.el @@ -194,7 +194,7 @@ "Non-nil means attempt auto-fixing of doc strings. If this value is the symbol `query', then the user is queried before any change is made. If the value is `automatic', then all changes are -made without asking unless the change is very-complex. If the value +made without asking unless the change is very complex. If the value is `semiautomatic' or any other value, then simple fixes are made without asking, and complex changes are made by asking the user first. The value `never' is the same as nil, never ask or change anything." @@ -238,10 +238,10 @@ This is automatically set to nil if Ispell does not exist on your system. Possible values are: nil - Don't spell-check during basic style checks. - defun - Spell-check when style checking a single defun - buffer - Spell-check when style checking the whole buffer + defun - Spell-check when style checking a single defun. + buffer - Spell-check when style checking the whole buffer. interactive - Spell-check during any interactive check. - t - Always spell-check" + t - Always spell-check." :type '(choice (const nil) (const defun) (const buffer) @@ -1050,7 +1050,7 @@ space at the end of each line." (defun checkdoc-ispell () "Check the style and spelling of everything interactively. Calls `checkdoc' with spell-checking turned on. -Prefix argument is the same as for `checkdoc'" +Prefix argument is the same as for `checkdoc'." (interactive) (let ((checkdoc-spellcheck-documentation-flag t)) (call-interactively #'checkdoc))) @@ -1059,7 +1059,7 @@ Prefix argument is the same as for `checkdoc'" (defun checkdoc-ispell-current-buffer () "Check the style and spelling of the current buffer. Calls `checkdoc-current-buffer' with spell-checking turned on. -Prefix argument is the same as for `checkdoc-current-buffer'" +Prefix argument is the same as for `checkdoc-current-buffer'." (interactive) (let ((checkdoc-spellcheck-documentation-flag t)) (call-interactively #'checkdoc-current-buffer))) @@ -1068,7 +1068,7 @@ Prefix argument is the same as for `checkdoc-current-buffer'" (defun checkdoc-ispell-interactive () "Check the style and spelling of the current buffer interactively. Calls `checkdoc-interactive' with spell-checking turned on. -Prefix argument is the same as for `checkdoc-interactive'" +Prefix argument is the same as for `checkdoc-interactive'." (interactive) (let ((checkdoc-spellcheck-documentation-flag t)) (call-interactively #'checkdoc-interactive))) @@ -1077,7 +1077,7 @@ Prefix argument is the same as for `checkdoc-interactive'" (defun checkdoc-ispell-message-interactive () "Check the style and spelling of message text interactively. Calls `checkdoc-message-interactive' with spell-checking turned on. -Prefix argument is the same as for `checkdoc-message-interactive'" +Prefix argument is the same as for `checkdoc-message-interactive'." (interactive) (let ((checkdoc-spellcheck-documentation-flag t)) (call-interactively #'checkdoc-message-interactive @@ -1087,7 +1087,7 @@ Prefix argument is the same as for `checkdoc-message-interactive'" (defun checkdoc-ispell-message-text () "Check the style and spelling of message text interactively. Calls `checkdoc-message-text' with spell-checking turned on. -Prefix argument is the same as for `checkdoc-message-text'" +Prefix argument is the same as for `checkdoc-message-text'." (interactive) (let ((checkdoc-spellcheck-documentation-flag t)) (call-interactively #'checkdoc-message-text))) @@ -1096,7 +1096,7 @@ Prefix argument is the same as for `checkdoc-message-text'" (defun checkdoc-ispell-start () "Check the style and spelling of the current buffer. Calls `checkdoc-start' with spell-checking turned on. -Prefix argument is the same as for `checkdoc-start'" +Prefix argument is the same as for `checkdoc-start'." (interactive) (let ((checkdoc-spellcheck-documentation-flag t)) (call-interactively #'checkdoc-start))) @@ -1105,7 +1105,7 @@ Prefix argument is the same as for `checkdoc-start'" (defun checkdoc-ispell-continue () "Check the style and spelling of the current buffer after point. Calls `checkdoc-continue' with spell-checking turned on. -Prefix argument is the same as for `checkdoc-continue'" +Prefix argument is the same as for `checkdoc-continue'." (interactive) (let ((checkdoc-spellcheck-documentation-flag t)) (call-interactively #'checkdoc-continue))) @@ -1114,7 +1114,7 @@ Prefix argument is the same as for `checkdoc-continue'" (defun checkdoc-ispell-comments () "Check the style and spelling of the current buffer's comments. Calls `checkdoc-comments' with spell-checking turned on. -Prefix argument is the same as for `checkdoc-comments'" +Prefix argument is the same as for `checkdoc-comments'." (interactive) (let ((checkdoc-spellcheck-documentation-flag t)) (call-interactively #'checkdoc-comments))) @@ -1123,7 +1123,7 @@ Prefix argument is the same as for `checkdoc-comments'" (defun checkdoc-ispell-defun () "Check the style and spelling of the current defun with Ispell. Calls `checkdoc-defun' with spell-checking turned on. -Prefix argument is the same as for `checkdoc-defun'" +Prefix argument is the same as for `checkdoc-defun'." (interactive) (let ((checkdoc-spellcheck-documentation-flag t)) (call-interactively #'checkdoc-defun))) diff --git a/lisp/emacs-lisp/cl-generic.el b/lisp/emacs-lisp/cl-generic.el index 10190f4933..b0173dc991 100644 --- a/lisp/emacs-lisp/cl-generic.el +++ b/lisp/emacs-lisp/cl-generic.el @@ -22,7 +22,7 @@ ;;; Commentary: -;; This implements the most of CLOS's multiple-dispatch generic functions. +;; This implements most of CLOS's multiple-dispatch generic functions. ;; To use it you need either (require 'cl-generic) or (require 'cl-lib). ;; The main entry points are: `cl-defgeneric' and `cl-defmethod'. @@ -911,7 +911,7 @@ Can only be used from within the lexical body of a primary or around method." ;;; Add support for describe-function (defun cl--generic-search-method (met-name) - "For `find-function-regexp-alist'. Searches for a cl-defmethod. + "For `find-function-regexp-alist'. Searches for a cl-defmethod. MET-NAME is as returned by `cl--generic-load-hist-format'." (let ((base-re (concat "(\\(?:cl-\\)?defmethod[ \t]+" (regexp-quote (format "%s" (car met-name))) diff --git a/lisp/emacs-lisp/eieio-custom.el b/lisp/emacs-lisp/eieio-custom.el index 350fca6d9a..8fc74beca1 100644 --- a/lisp/emacs-lisp/eieio-custom.el +++ b/lisp/emacs-lisp/eieio-custom.el @@ -454,7 +454,7 @@ Must return the created widget." (cl-defmethod eieio-read-customization-group ((obj eieio-default-superclass)) "Do a completing read on the name of a customization group in OBJ. -Return the symbol for the group, or nil" +Return the symbol for the group, or nil." (let ((g (eieio--class-option (eieio--object-class obj) :custom-groups))) (if (= (length g) 1) diff --git a/lisp/emacs-lisp/lisp.el b/lisp/emacs-lisp/lisp.el index ab0e853e9a..93d43e319a 100644 --- a/lisp/emacs-lisp/lisp.el +++ b/lisp/emacs-lisp/lisp.el @@ -60,8 +60,8 @@ Should take the same arguments and behave similarly to `forward-sexp'.") With ARG, do it that many times. Negative arg -N means move backward across N balanced expressions. This command assumes point is not in a string or comment. Calls -`forward-sexp-function' to do the work, if that is non-nil. If -unable to move over a sexp, signal `scan-error' with three +`forward-sexp-function' to do the work, if that is non-nil. +If unable to move over a sexp, signal `scan-error' with three arguments: a message, the start of the obstacle (usually a parenthesis or list marker of some kind), and end of the obstacle." @@ -164,7 +164,7 @@ This command will also work on other parentheses-like expressions defined by the current language mode. With ARG, do this that many times. A negative argument means move backward but still to a less deep spot. If ESCAPE-STRINGS is non-nil (as it is -interactively), move out of enclosing strings as well. If +interactively), move out of enclosing strings as well. If NO-SYNTAX-CROSSING is non-nil (as it is interactively), prefer to break out of any enclosing string instead of moving to the start of a list broken across multiple strings. On error, location of diff --git a/lisp/emacs-lisp/package-x.el b/lisp/emacs-lisp/package-x.el index e26b6b99c1..2815be3fe6 100644 --- a/lisp/emacs-lisp/package-x.el +++ b/lisp/emacs-lisp/package-x.el @@ -124,7 +124,7 @@ Return the file contents, as a string, or nil if unsuccessful." (buffer-substring-no-properties (point-min) (point-max))))))) (defun package--archive-contents-from-file () - "Parse the archive-contents at `package-archive-upload-base'" + "Parse the archive-contents at `package-archive-upload-base'." (let ((file (expand-file-name "archive-contents" package-archive-upload-base))) (if (not (file-exists-p file)) diff --git a/lisp/emacs-lisp/package.el b/lisp/emacs-lisp/package.el index 1e136cb54f..409dfedb74 100644 --- a/lisp/emacs-lisp/package.el +++ b/lisp/emacs-lisp/package.el @@ -448,11 +448,11 @@ Slots: `summary' Short description of the package, typically taken from the first line of the file. -`reqs' Requirements of the package. A list of (PACKAGE +`reqs' Requirements of the package. A list of (PACKAGE VERSION-LIST) naming the dependent package and the minimum required version. -`kind' The distribution format of the package. Currently, it is +`kind' The distribution format of the package. Currently, it is either `single' or `tar'. `archive' The name of the archive (as a string) whence this @@ -980,7 +980,7 @@ untar into a directory named DIR; otherwise, signal an error." auto-name)) (defun package--make-autoloads-and-stuff (pkg-desc pkg-dir) - "Generate autoloads, description file, etc.. for PKG-DESC installed at PKG-DIR." + "Generate autoloads, description file, etc., for PKG-DESC installed at PKG-DIR." (package-generate-autoloads (package-desc-name pkg-desc) pkg-dir) (let ((desc-file (expand-file-name (package--description-file pkg-dir) pkg-dir))) @@ -2843,7 +2843,7 @@ If the name of a package matches any of these regexps it is omitted from the package menu. To toggle this, type \\[package-menu-toggle-hiding]. Values can be interactively added to this list by typing -\\[package-menu-hide-package] on a package" +\\[package-menu-hide-package] on a package." :version "25.1" :type '(repeat (regexp :tag "Hide packages with name matching"))) diff --git a/lisp/emacs-lisp/tcover-ses.el b/lisp/emacs-lisp/tcover-ses.el index d34d30ff0f..e18cc58b64 100644 --- a/lisp/emacs-lisp/tcover-ses.el +++ b/lisp/emacs-lisp/tcover-ses.el @@ -627,7 +627,7 @@ spreadsheet files with invalid formatting." (error nil))))) (defun ses-exercise-startup () - "Prepare for coverage tests" + "Prepare for coverage tests." ;;Clean up from any previous runs (condition-case nil (kill-buffer "ses-example.ses") (error nil)) (condition-case nil (kill-buffer "ses-test.ses") (error nil)) diff --git a/lisp/emacs-lisp/testcover.el b/lisp/emacs-lisp/testcover.el index 20851805f5..16f19f7d50 100644 --- a/lisp/emacs-lisp/testcover.el +++ b/lisp/emacs-lisp/testcover.el @@ -150,12 +150,12 @@ call to one of the `testcover-1value-functions'." (defface testcover-nohits '((t (:background "DeepPink2"))) - "Face for forms that had no hits during coverage test" + "Face for forms that had no hits during coverage test." :group 'testcover) (defface testcover-1value '((t (:background "Wheat2"))) - "Face for forms that always produced the same value during coverage test" + "Face for forms that always produced the same value during coverage test." :group 'testcover) diff --git a/lisp/epg.el b/lisp/epg.el index 6d377d07e2..1a107600a5 100644 --- a/lisp/epg.el +++ b/lisp/epg.el @@ -1902,7 +1902,7 @@ If you are unsure, use synchronous version of this function (defun epg-receive-keys (context keys) "Add keys from server. -KEYS is a list of key IDs" +KEYS is a list of key IDs." (unwind-protect (progn (epg-start-receive-keys context keys) @@ -2002,7 +2002,7 @@ PARAMETERS is a string which tells how to create the key." (defun epg-start-edit-key (context key edit-callback handback) "Initiate an edit operation on KEY. -EDIT-CALLBACK is called from process filter and takes 3 +EDIT-CALLBACK is called from process filter and takes four arguments: the context, a status, an argument string, and the handback argument. diff --git a/lisp/erc/erc-backend.el b/lisp/erc/erc-backend.el index 210830a2b4..8b30834025 100644 --- a/lisp/erc/erc-backend.el +++ b/lisp/erc/erc-backend.el @@ -261,7 +261,7 @@ but has not been processed yet.") "Non-nil when we're currently processing a message. When ERC receives a private message, it sets up a new buffer for -this query. These in turn, though, do start flyspell. This +this query. These in turn, though, do start flyspell. This involves starting an external process, in which case Emacs will wait - and when it waits, it does accept other stuff from, say, network exceptions. So, if someone sends you two messages @@ -320,7 +320,7 @@ If a key is pressed while ERC is waiting, it will stop waiting." "The maximum length of a single message. If a message exceeds this size, it is broken into multiple ones. -IRC allows for lines up to 512 bytes. Two of them are CR LF. +IRC allows for lines up to 512 bytes. Two of them are CR LF. And a typical message looks like this: :nicky!uhuser@host212223.dialin.fnordisp.net PRIVMSG #lazybastards :Hello! @@ -347,8 +347,8 @@ This will only be consulted if the coding system in This is either a coding system, a cons, a function, or nil. If a cons, the encoding system for outgoing text is in the car -and the decoding system for incoming text is in the cdr. The most -interesting use for this is to put `undecided' in the cdr. This +and the decoding system for incoming text is in the cdr. The most +interesting use for this is to put `undecided' in the cdr. This means that `erc-coding-system-precedence' will be consulted, and the first match there will be used. @@ -795,7 +795,7 @@ Use DISPLAY-FN to show the results." (defun erc-server-send (string &optional forcep target) "Send STRING to the current server. If FORCEP is non-nil, no flood protection is done - the string is -sent directly. This might cause the messages to arrive in a wrong +sent directly. This might cause the messages to arrive in a wrong order. If TARGET is specified, look up encoding information for that @@ -903,7 +903,7 @@ protection algorithm." "Send LINE to the server as a privmsg or a notice. MESSAGE-COMMAND should be either \"PRIVMSG\" or \"NOTICE\". If the target is \",\", the last person you've got a message from will -be used. If the target is \".\", the last person you've sent a message +be used. If the target is \".\", the last person you've sent a message to will be used." (cond ((string-match "^\\s-*\\(\\S-+\\) ?\\(.*\\)" line) diff --git a/lisp/erc/erc-button.el b/lisp/erc/erc-button.el index 726d9674d4..2dbf13cfdf 100644 --- a/lisp/erc/erc-button.el +++ b/lisp/erc/erc-button.el @@ -71,7 +71,7 @@ "Face used for highlighting buttons in ERC buffers. A button is a piece of text that you can activate by pressing -`RET' or `mouse-2' above it. See also `erc-button-keymap'." +`RET' or `mouse-2' above it. See also `erc-button-keymap'." :type 'face :group 'erc-faces) @@ -169,10 +169,10 @@ REGEXP is the string matching text around the button or a symbol current server. BUTTON is the number of the regexp grouping actually matching the - button, This is ignored if REGEXP is \\='nicknames. + button. This is ignored if REGEXP is \\='nicknames. FORM is a lisp expression which must eval to true for the button to - be added, + be added. CALLBACK is the function to call when the user push this button. CALLBACK can also be a symbol. Its variable value will be used @@ -459,7 +459,7 @@ For use on `completion-at-point-functions'." t))) (defun erc-browse-emacswiki (thing) - "Browse to thing in the emacs-wiki." + "Browse to THING in the emacs-wiki." (browse-url (concat erc-emacswiki-url thing))) (defun erc-browse-emacswiki-lisp (thing) diff --git a/lisp/erc/erc-ezbounce.el b/lisp/erc/erc-ezbounce.el index a2c9336826..899ea2f6b5 100644 --- a/lisp/erc/erc-ezbounce.el +++ b/lisp/erc/erc-ezbounce.el @@ -28,7 +28,7 @@ (require 'erc) (defgroup erc-ezbounce nil - "Interface to the EZBounce IRC bouncer (a virtual IRC server)" + "Interface to the EZBounce IRC bouncer (a virtual IRC server)." :group 'erc) (defcustom erc-ezb-regexp "^ezbounce!srv$" @@ -77,7 +77,7 @@ The alist's format is as follows: ;;;###autoload (defun erc-ezb-get-login (server port) "Return an appropriate EZBounce login for SERVER and PORT. -Look up entries in `erc-ezb-login-alist'. If the username or password +Look up entries in `erc-ezb-login-alist'. If the username or password in the alist is nil, prompt for the appropriate values." (let ((login (cdr (assoc (cons server port) erc-ezb-login-alist)))) (when login diff --git a/lisp/erc/erc-fill.el b/lisp/erc/erc-fill.el index 934b52a938..705c7e69bb 100644 --- a/lisp/erc/erc-fill.el +++ b/lisp/erc/erc-fill.el @@ -109,7 +109,7 @@ nick names right and text left." (defcustom erc-fill-variable-maximum-indentation 17 "If we indent a line after a long nick, don't indent more then this -characters. Set to nil to disable." +characters. Set to nil to disable." :group 'erc-fill :type 'integer) diff --git a/lisp/erc/erc-log.el b/lisp/erc/erc-log.el index 1c046fe20c..2b9a0aae1d 100644 --- a/lisp/erc/erc-log.el +++ b/lisp/erc/erc-log.el @@ -340,7 +340,7 @@ filename is downcased." "Return the logfile to use for BUFFER. If BUFFER is nil, the value of `current-buffer' is used. This is determined by `erc-generate-log-file-name-function'. -The result is converted to lowercase, as IRC is case-insensitive" +The result is converted to lowercase, as IRC is case-insensitive." (unless buffer (setq buffer (current-buffer))) (with-current-buffer buffer (let ((target (or (buffer-name buffer) (erc-default-target))) diff --git a/lisp/erc/erc-match.el b/lisp/erc/erc-match.el index cc4b4a88f1..092b5953c4 100644 --- a/lisp/erc/erc-match.el +++ b/lisp/erc/erc-match.el @@ -199,8 +199,8 @@ When `away', log messages only when away." (defcustom erc-log-match-format "%t<%n:%c> %m" "Format for matched Messages. -This variable specifies how messages in the corresponding log buffers will -be formatted. The various format specs are: +This variable specifies how messages in the corresponding log buffers +will be formatted. The various format specs are: %t Timestamp (uses `erc-timestamp-format' if non-nil or \"[%Y-%m-%d %H:%M] \") %n Nickname of sender @@ -227,7 +227,7 @@ for beeping to work." "Hook run when text matches a given match-type. Functions in this hook are passed as arguments: \(match-type nick!user@host message) where MATCH-TYPE is a symbol of: -current-nick, keyword, pal, dangerous-host, fool" +current-nick, keyword, pal, dangerous-host, fool." :options '(erc-log-matches erc-hide-fools erc-beep-on-match) :group 'erc-match :type 'hook) diff --git a/lisp/erc/erc-netsplit.el b/lisp/erc/erc-netsplit.el index 87c3a61b66..305fdf9d94 100644 --- a/lisp/erc/erc-netsplit.el +++ b/lisp/erc/erc-netsplit.el @@ -33,9 +33,9 @@ (require 'erc) (defgroup erc-netsplit nil - "Netsplit detection tries to automatically figure when a -netsplit happens, and filters the QUIT messages. It also keeps -track of netsplits, so that it can filter the JOIN messages on a netjoin too." + "Netsplit detection tries to automatically figure when a netsplit +happens, and filters the QUIT messages. It also keeps track of +netsplits, so that it can filter the JOIN messages on a netjoin too." :group 'erc) ;;;###autoload(autoload 'erc-netsplit-mode "erc-netsplit") @@ -57,8 +57,7 @@ track of netsplits, so that it can filter the JOIN messages on a netjoin too." :type 'boolean) (defcustom erc-netsplit-debug nil - "If non-nil, debug messages will be shown in the -sever buffer." + "If non-nil, debug messages will be shown in the sever buffer." :group 'erc-netsplit :type 'boolean) diff --git a/lisp/erc/erc-networks.el b/lisp/erc/erc-networks.el index eca8ad6a89..3ba5ce4e5e 100644 --- a/lisp/erc/erc-networks.el +++ b/lisp/erc/erc-networks.el @@ -436,10 +436,11 @@ ("ZiRC: Random server" ZiRC "irc.zirc.org" ((6660 6669))) ("ZUHnet: Random server" ZUHnet "irc.zuh.net" 6667) ("Zurna: Random server" Zurna "irc.zurna.net" 6667)) - "Alist of irc servers. (NAME NET HOST PORTS) where + "Alist of irc servers. +Each server is a list (NAME NET HOST PORTS) where NAME is a name for that server, -NET is a symbol indicating to which network from `erc-networks-alist' this - server corresponds, +NET is a symbol indicating to which network from `erc-networks-alist' + this server corresponds, HOST is the servers hostname and PORTS is either a number, a list of numbers, or a list of port ranges." :group 'erc-networks @@ -706,12 +707,13 @@ PORTS is either a number, a list of numbers, or a list of port ranges." (ZiRC "zirc.org") (ZUHnet "zuh.net") (Zurna "zurna.net")) - "Alist of IRC networks. (NET MATCHER) where + "Alist of IRC networks. +Each network is a list (NET MATCHER) where NET is a symbol naming that IRC network and -MATCHER is used to find a corresponding network to a server while connected to - it. If it is regexp, it's used to match against `erc-server-announced-name'. - It can also be a function (predicate). Then it is executed with the - server buffer as current-buffer." +MATCHER is used to find a corresponding network to a server while + connected to it. If it is regexp, it's used to match against + `erc-server-announced-name'. It can also be a function (predicate). + Then it is executed with the server buffer as current-buffer." :group 'erc-networks :type '(repeat (list :tag "Network" @@ -749,8 +751,8 @@ search for a match in `erc-networks-alist'." (erc-with-server-buffer erc-network)) (defun erc-current-network () - "Deprecated. Use `erc-network' instead. Return the name of this server's -network as a symbol." + "Deprecated. Use `erc-network' instead. +Return the name of this server's network as a symbol." (erc-with-server-buffer (intern (downcase (symbol-name erc-network))))) diff --git a/lisp/erc/erc-ring.el b/lisp/erc/erc-ring.el index 453e234a37..c5d62ccfea 100644 --- a/lisp/erc/erc-ring.el +++ b/lisp/erc/erc-ring.el @@ -59,7 +59,7 @@ be recalled using M-p and M-n." (defvar erc-input-ring-index nil "Position in the input ring for erc. If nil, the input line is blank and the user is conceptually after -the most recently added item in the ring. If an integer, the input +the most recently added item in the ring. If an integer, the input line is non-blank and displays the item from the ring indexed by this variable.") (make-variable-buffer-local 'erc-input-ring-index) diff --git a/lisp/erc/erc-speedbar.el b/lisp/erc/erc-speedbar.el index 8d56c85bec..a1e10ca3a2 100644 --- a/lisp/erc/erc-speedbar.el +++ b/lisp/erc/erc-speedbar.el @@ -42,7 +42,7 @@ ;;; Customization: (defgroup erc-speedbar nil - "Integration of ERC in the Speedbar" + "Integration of ERC in the Speedbar." :group 'erc) (defcustom erc-speedbar-sort-users-type 'activity @@ -270,8 +270,8 @@ INDENT is the current indentation level." indent)))) (defun erc-speedbar-update-channel (buffer) - "Update the speedbar information about a ERC buffer. The update -is only done when the channel is actually expanded already." + "Update the speedbar information about a ERC buffer. +The update is only done when the channel is actually expanded already." ;; This is only a rude hack and doesn't care about multiserver usage ;; yet, consider this a brain storming, better ideas? (with-current-buffer speedbar-buffer diff --git a/lisp/erc/erc-stamp.el b/lisp/erc/erc-stamp.el index a15d8bf7b3..ee177e3acb 100644 --- a/lisp/erc/erc-stamp.el +++ b/lisp/erc/erc-stamp.el @@ -212,7 +212,7 @@ This is used when `erc-insert-timestamp-function' is set to "Insert timestamp only if its value changed since last insertion. If `erc-insert-timestamp-function' is `erc-insert-timestamp-left', a string of spaces which is the same size as the timestamp is added to -the beginning of the line in its place. If you use +the beginning of the line in its place. If you use `erc-insert-timestamp-right', nothing gets inserted in place of the timestamp." :group 'erc-stamp diff --git a/lisp/erc/erc-track.el b/lisp/erc/erc-track.el index 53a5920783..055c2eb485 100644 --- a/lisp/erc/erc-track.el +++ b/lisp/erc/erc-track.el @@ -245,7 +245,7 @@ The effect may be disabled by setting this variable to nil." (defcustom erc-track-position-in-mode-line 'before-modes "Where to show modified channel information in the mode-line. -Setting this variable only has effects in GNU Emacs versions above 21.3. +Setting this variable only has effect in GNU Emacs versions above 21.3. Choices are: `before-modes' - add to the beginning of `mode-line-modes', @@ -328,7 +328,7 @@ important." (defun erc-track-remove-from-mode-line () - "Remove `erc-track-modified-channels' from the mode-line" + "Remove `erc-track-modified-channels' from the mode-line." (when (boundp 'mode-line-modes) (setq mode-line-modes (remove '(t erc-modified-channels-object) mode-line-modes))) @@ -628,7 +628,7 @@ because the debugger also causes changes to the window-configuration.") (defun erc-modified-channels-update (&rest _args) "This function updates the information in `erc-modified-channels-alist' according to buffer visibility. It calls -`erc-modified-channels-display' at the end. This should usually be +`erc-modified-channels-display' at the end. This should usually be called via `window-configuration-change-hook'. ARGS are ignored." (interactive) @@ -864,7 +864,7 @@ is in `erc-mode'." (defvar erc-track-last-non-erc-buffer nil "Stores the name of the last buffer you were in before activating -`erc-track-switch-buffers'") +`erc-track-switch-buffers'.") (defun erc-track-sort-by-activest () "Sort erc-modified-channels-alist by activity. @@ -889,7 +889,7 @@ higher number than any other face in that list." count)) (defun erc-track-sort-by-importance () - "Sort erc-modified-channels-alist by importance. + "Sort `erc-modified-channels-alist' by importance. That means the position of the face in `erc-track-faces-priority-list'." (setq erc-modified-channels-alist (sort erc-modified-channels-alist @@ -898,8 +898,8 @@ That means the position of the face in `erc-track-faces-priority-list'." (defun erc-track-get-active-buffer (arg) "Return the buffer name of ARG in `erc-modified-channels-alist'. -Negative arguments index in the opposite direction. This direction is -relative to `erc-track-switch-direction'" +Negative arguments index in the opposite direction. This direction +is relative to `erc-track-switch-direction'." (let ((dir erc-track-switch-direction) offset) (when (< arg 0) diff --git a/lisp/erc/erc.el b/lisp/erc/erc.el index fd1bd5545d..74376b0cb3 100644 --- a/lisp/erc/erc.el +++ b/lisp/erc/erc.el @@ -558,7 +558,7 @@ of the list is of the form (USER . CHANNEL-DATA), where USER is an erc-server-user struct, and CHANNEL-DATA is either nil or an erc-channel-user struct. -See also: `erc-sort-channel-users-by-activity'" +See also: `erc-sort-channel-users-by-activity'." (let (users) (if (hash-table-p erc-channel-users) (maphash (lambda (_nick cdata) @@ -739,7 +739,7 @@ See also: `erc-echo-notice-always-hook', `erc-echo-notice-in-active-buffer', `erc-echo-notice-in-user-buffers', `erc-echo-notice-in-user-and-target-buffers', -`erc-echo-notice-in-first-user-buffer'" +`erc-echo-notice-in-first-user-buffer'." :group 'erc-hooks :type 'hook :options '(erc-echo-notice-in-default-buffer @@ -770,7 +770,7 @@ See also: `erc-echo-notice-hook', `erc-echo-notice-in-active-buffer', `erc-echo-notice-in-user-buffers', `erc-echo-notice-in-user-and-target-buffers', -`erc-echo-notice-in-first-user-buffer'" +`erc-echo-notice-in-first-user-buffer'." :group 'erc-hooks :type 'hook :options '(erc-echo-notice-in-default-buffer @@ -4194,7 +4194,7 @@ Only happens when the session buffer isn't visible." Specifically in relation to NICK (user@host) information. Returns REASON unmodified if nothing can be removed. E.g. \"Read error to Nick [user@some.host]: 110\" would be shortened to -\"Read error: 110\". The same applies for \"Ping Timeout\"." +\"Read error: 110\". The same applies for \"Ping Timeout\"." (setq nick (regexp-quote nick) login (regexp-quote login) host (regexp-quote host)) @@ -4337,7 +4337,7 @@ See also `erc-format-nick-function'." (defun erc-format-@nick (&optional user _channel-data) "Format the nickname of USER showing if USER has a voice, is an -operator, half-op, admin or owner. Owners have \"~\", admins have +operator, half-op, admin or owner. Owners have \"~\", admins have \"&\", operators have \"@\" and users with voice have \"+\" as a prefix. Use CHANNEL-DATA to determine op and voice status. See also `erc-format-nick-function'." diff --git a/lisp/ffap.el b/lisp/ffap.el index 33854a6c0d..5b4e8b5fca 100644 --- a/lisp/ffap.el +++ b/lisp/ffap.el @@ -950,7 +950,7 @@ appending SUFFIX.") (defun ffap-latex-mode (name) "`ffap' function suitable for latex buffers. -This uses the program kpsewhich if available. In this case, the +This uses the program kpsewhich if available. In this case, the variable `ffap-latex-guess-rules' is used for building a filename out of NAME." (cond ((file-exists-p name) diff --git a/lisp/files.el b/lisp/files.el index 5ceaacd744..0c3da1fe3c 100644 --- a/lisp/files.el +++ b/lisp/files.el @@ -2132,9 +2132,9 @@ think it does, because \"free\" is pretty hard to define in practice." "If file SIZE larger than `large-file-warning-threshold', allow user to abort. OP-TYPE specifies the file operation being performed (for message to user). If OFFER-RAW is true, give user the additional option -to open the file literally. If the user chooses this option, -`abort-if-file-too-large' returns the symbol `raw'. Otherwise, it -returns nil or exits non-locally." +to open the file literally. If the user chooses this option, +`abort-if-file-too-large' returns the symbol `raw'. Otherwise, +it returns nil or exits non-locally." (let ((choice (and large-file-warning-threshold size (> size large-file-warning-threshold) ;; No point in warning if we can't read it. @@ -4177,8 +4177,8 @@ This function returns either: NODE is assumed to be a cons cell where the car is either a string or a symbol representing a mode name. -If it is a mode then the the depth of the mode (ie, how many -parents that mode has) will be returned. +If it is a mode then the depth of the mode (ie, how many parents +that mode has) will be returned. If it is a string then the length of the string plus 1000 will be returned. @@ -5934,7 +5934,7 @@ This returns non-nil if the current buffer is visiting a readable file whose modification time does not match that of the buffer. This function only handles buffers that are visiting files. -Non-file buffers need a custom function" +Non-file buffers need a custom function." (and buffer-file-name (file-readable-p buffer-file-name) (not (buffer-modified-p (current-buffer))) diff --git a/lisp/filesets.el b/lisp/filesets.el index b74b4a8a40..c05fff3fb7 100644 --- a/lisp/filesets.el +++ b/lisp/filesets.el @@ -545,8 +545,8 @@ computer environments." (defcustom filesets-tree-max-level 3 "Maximum scan depth for directory trees. A :tree fileset is defined by a base directory the contents of which -will be recursively added to the menu. `filesets-tree-max-level' tells up -to which level the directory structure should be scanned/listed, +will be recursively added to the menu. `filesets-tree-max-level' tells +up to which level the directory structure should be scanned/listed, i.e. how deep the menu should be. Try something like (\"HOME -- only one level\" @@ -966,11 +966,11 @@ Example definition: `filesets-data' is a list of (NAME-AS-STRING . DEFINITION), DEFINITION being an association list with the fields: -:files FILE-1 .. FILE-N ... a list of files belonging to a fileset +:files FILE-1 .. FILE-N ... a list of files belonging to a fileset. :ingroup FILE-NAME ... an inclusion group's base file. -:tree ROOT-DIR PATTERN ... a base directory and a file pattern +:tree ROOT-DIR PATTERN ... a base directory and a file pattern. :pattern DIR PATTERN ... a base directory and a regexp matching files in that directory. Usually, @@ -981,17 +981,17 @@ being an association list with the fields: :filter-dirs-flag BOOLEAN ... is only used in conjunction with :tree. :tree-max-level INTEGER ... recurse into directories this many levels -\(see `filesets-tree-max-level' for a full explanation) +\(see `filesets-tree-max-level' for a full explanation). :dormant-flag BOOLEAN ... non-nil means don't show this item in the menu; dormant filesets can still be manipulated via commands available from the minibuffer -- e.g. `filesets-open', `filesets-close', or -`filesets-run-cmd' +`filesets-run-cmd'. -:dormant-p FUNCTION ... a function returning :dormant-flag +:dormant-p FUNCTION ... a function returning :dormant-flag. :open FUNCTION ... the function used to open file belonging to this -fileset. The function takes a file name as argument +fileset. The function takes a file name as argument. :save FUNCTION ... the function used to save file belonging to this fileset; it takes no arguments, but works on the current buffer. @@ -1003,7 +1003,8 @@ optional. In conjunction with the :tree tag, :save is void. :open refers to the function used for opening files in a directory, not for opening the -directory. For browsing directories, `filesets-browse-dir-function' is used. +directory. For browsing directories, `filesets-browse-dir-function' +is used. Before using :ingroup, make sure that the file type is already defined in `filesets-ingroup-patterns'." @@ -2440,10 +2441,10 @@ fileset thinks this is necessary or not." "Filesets: manual editing of user data required! Filesets has detected that you were using an older version before, -which requires some manual updating. Type `y' for editing the startup +which requires some manual updating. Type `y' for editing the startup file now. -The layout of `filesets-data' has changed. Please delete your cache file +The layout of `filesets-data' has changed. Please delete your cache file and edit your startup file as shown below: 1. `filesets-data': Edit all :pattern filesets in your startup file and diff --git a/lisp/gnus/gnus-agent.el b/lisp/gnus/gnus-agent.el index dd30dda2a1..1f25255278 100644 --- a/lisp/gnus/gnus-agent.el +++ b/lisp/gnus/gnus-agent.el @@ -1739,9 +1739,9 @@ the article files." (defun gnus-agent-flush-cache () "Flush the agent's index files such that the group no longer appears to have any local content. The actual content, the -article files, is then deleted using gnus-agent-expire-group. The -gnus-agent-regenerate-group method provides an undo mechanism by -reconstructing the index files from the article files." +article files, is then deleted using gnus-agent-expire-group. +The gnus-agent-regenerate-group method provides an undo mechanism +by reconstructing the index files from the article files." (interactive) (save-excursion (let ((file-name-coding-system nnmail-pathname-coding-system)) diff --git a/lisp/gnus/gnus-art.el b/lisp/gnus/gnus-art.el index eba66c1c3a..07ec269646 100644 --- a/lisp/gnus/gnus-art.el +++ b/lisp/gnus/gnus-art.el @@ -1594,7 +1594,7 @@ predicate. See Info node `(gnus)Customizing Articles'." ;; gnus-article-encrypt-protocol-alist. (defcustom gnus-article-encrypt-protocol "PGP" "The protocol used for encrypt articles. -It is a string, such as \"PGP\". If nil, ask user." +It is a string, such as \"PGP\". If nil, ask user." :version "22.1" :type 'string :group 'mime-security) @@ -7374,7 +7374,7 @@ man page." Strings like this can be either a message ID or a mail address. If it is one of the symbols `mid' or `mail', Gnus will always assume that the string is a message ID or a mail address, respectively. If this variable is set to the -symbol `ask', always query the user what do do. If it is a function, this +symbol `ask', always query the user what to do. If it is a function, this function will be called with the string as its only argument. The function must return `mid', `mail', `invalid' or `ask'." :version "22.1" diff --git a/lisp/gnus/gnus-cus.el b/lisp/gnus/gnus-cus.el index a4daf8cf48..2e3fbfe9d4 100644 --- a/lisp/gnus/gnus-cus.el +++ b/lisp/gnus/gnus-cus.el @@ -190,7 +190,7 @@ Which articles to display on entering the group. unread and ticked articles. `Other' - Display the articles that satisfy the S-expression. The S-expression + Display the articles that satisfy the S-expression. The S-expression should be in an array form.") (comment (string :tag "Comment") "\ diff --git a/lisp/gnus/gnus-demon.el b/lisp/gnus/gnus-demon.el index 6007e18f55..7ec471afc7 100644 --- a/lisp/gnus/gnus-demon.el +++ b/lisp/gnus/gnus-demon.el @@ -44,7 +44,7 @@ Each handler is a list on the form FUNCTION is the function to be called. TIME is the number of `gnus-demon-timestep's between each call. -If nil, never call. If t, call each `gnus-demon-timestep'. +If nil, never call. If t, call each `gnus-demon-timestep'. If IDLE is t, only call each time Emacs has been idle for TIME. If IDLE is a number, only call when Emacs has been idle more than @@ -98,8 +98,8 @@ Emacs has been idle for IDLE `gnus-demon-timestep's." (defun gnus-demon-run-callback (func &optional idle time special) "Run FUNC if Emacs has been idle for longer than IDLE seconds. If not, and a TIME is given, restart a new idle timer, so FUNC -can be called at the next opportunity. Such a special idle run is -marked with SPECIAL." +can be called at the next opportunity. Such a special idle run +is marked with SPECIAL." (unless gnus-inhibit-demon (cl-block run-callback (when (eq idle t) diff --git a/lisp/gnus/gnus-dired.el b/lisp/gnus/gnus-dired.el index acb8fd7764..818beca77b 100644 --- a/lisp/gnus/gnus-dired.el +++ b/lisp/gnus/gnus-dired.el @@ -209,11 +209,11 @@ If ARG is non-nil, open it in a new buffer." (defun gnus-dired-print (&optional file-name print-to) "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. If -PRINT-TO is a string, save the PostScript image in a file with that -name. If PRINT-TO is a number, prompt the user for the name of the -file to save in." +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. +If PRINT-TO is a string, save the PostScript image in a file with +that name. If PRINT-TO is a number, prompt the user for the name +of the file to save in." (interactive (list (file-name-sans-versions (dired-get-filename) t) (ps-print-preprint current-prefix-arg))) diff --git a/lisp/gnus/gnus-icalendar.el b/lisp/gnus/gnus-icalendar.el index 7d11b5699b..e4779f52c0 100644 --- a/lisp/gnus/gnus-icalendar.el +++ b/lisp/gnus/gnus-icalendar.el @@ -250,10 +250,11 @@ "Parse RFC5545 iCalendar in buffer BUF and return an event object. Return a gnus-icalendar-event object representing the first event -contained in the invitation. Return nil for calendars without an event entry. +contained in the invitation. Return nil for calendars without an +event entry. ATTENDEE-NAME-OR-EMAIL is a list of strings that will be matched -against the event's attendee names and emails. Invitation rsvp +against the event's attendee names and emails. Invitation rsvp status will be retrieved from the first matching attendee record." (let ((ical (with-current-buffer (icalendar--get-unfolded-buffer (get-buffer buf)) (goto-char (point-min)) diff --git a/lisp/gnus/gnus-range.el b/lisp/gnus/gnus-range.el index b775def9a0..52bcf79d40 100644 --- a/lisp/gnus/gnus-range.el +++ b/lisp/gnus/gnus-range.el @@ -28,7 +28,7 @@ (defsubst gnus-range-normalize (range) "Normalize RANGE. -If RANGE is a single range, return (RANGE). Otherwise, return RANGE." +If RANGE is a single range, return (RANGE). Otherwise, return RANGE." (if (listp (cdr-safe range)) range (list range))) (defun gnus-last-element (list) diff --git a/lisp/gnus/gnus-spec.el b/lisp/gnus/gnus-spec.el index 47d722c914..3f3efdcec9 100644 --- a/lisp/gnus/gnus-spec.el +++ b/lisp/gnus/gnus-spec.el @@ -344,8 +344,8 @@ Return a list of updated types." (defun gnus-pad-form (el pad-width) "Return a form that pads EL to PAD-WIDTH accounting for multi-column -characters correctly. This is because `format' may pad to columns or to -characters when given a pad value." +characters correctly. This is because `format' may pad to columns +or to characters when given a pad value." (let ((pad (abs pad-width)) (side (< 0 pad-width))) (if (symbolp el) diff --git a/lisp/gnus/gnus-srvr.el b/lisp/gnus/gnus-srvr.el index 71c7807518..684af23510 100644 --- a/lisp/gnus/gnus-srvr.el +++ b/lisp/gnus/gnus-srvr.el @@ -190,14 +190,14 @@ If nil, a faster, but more primitive, buffer is used instead." '((((class color) (background light)) (:foreground "PaleTurquoise" :bold t)) (((class color) (background dark)) (:foreground "PaleTurquoise" :bold t)) (t (:bold t))) - "Face used for displaying AGENTIZED servers" + "Face used for displaying AGENTIZED servers." :group 'gnus-server-visual) (defface gnus-server-cloud '((((class color) (background light)) (:foreground "ForestGreen" :bold t)) (((class color) (background dark)) (:foreground "PaleGreen" :bold t)) (t (:bold t))) - "Face used for displaying Cloud-synced servers" + "Face used for displaying Cloud-synced servers." :group 'gnus-server-visual) (defface gnus-server-cloud-host @@ -211,7 +211,7 @@ If nil, a faster, but more primitive, buffer is used instead." '((((class color) (background light)) (:foreground "Green3" :bold t)) (((class color) (background dark)) (:foreground "Green1" :bold t)) (t (:bold t))) - "Face used for displaying OPENED servers" + "Face used for displaying OPENED servers." :group 'gnus-server-visual) (defface gnus-server-closed @@ -219,21 +219,21 @@ If nil, a faster, but more primitive, buffer is used instead." (((class color) (background dark)) (:foreground "LightBlue" :italic t)) (t (:italic t))) - "Face used for displaying CLOSED servers" + "Face used for displaying CLOSED servers." :group 'gnus-server-visual) (defface gnus-server-denied '((((class color) (background light)) (:foreground "Red" :bold t)) (((class color) (background dark)) (:foreground "Pink" :bold t)) (t (:inverse-video t :bold t))) - "Face used for displaying DENIED servers" + "Face used for displaying DENIED servers." :group 'gnus-server-visual) (defface gnus-server-offline '((((class color) (background light)) (:foreground "Orange" :bold t)) (((class color) (background dark)) (:foreground "Yellow" :bold t)) (t (:inverse-video t :bold t))) - "Face used for displaying OFFLINE servers" + "Face used for displaying OFFLINE servers." :group 'gnus-server-visual) (defvar gnus-server-font-lock-keywords diff --git a/lisp/gnus/gnus-sum.el b/lisp/gnus/gnus-sum.el index b8f96158e6..d175106550 100644 --- a/lisp/gnus/gnus-sum.el +++ b/lisp/gnus/gnus-sum.el @@ -145,8 +145,8 @@ If t, fetch all the available old headers." (sexp :menu-tag "other" t))) (defcustom gnus-refer-thread-use-nnir nil - "Use nnir to search an entire server when referring threads. A -nil value will only search for thread-related articles in the + "Use nnir to search an entire server when referring threads. +A nil value will only search for thread-related articles in the current group." :version "24.1" :group 'gnus-thread @@ -154,7 +154,7 @@ current group." (defcustom gnus-refer-thread-limit-to-thread nil "If non-nil referring a thread will limit the summary buffer to -articles in the thread. A nil value will add the thread articles +articles in the thread. A nil value will add the thread articles to the summary buffer." :version "25.1" :group 'gnus-thread @@ -8655,7 +8655,7 @@ SCORE." (defun gnus-summary-limit-include-thread (id &optional thread-only) "Display all hidden articles belonging to thread ID. When called interactively, ID is the Message-ID of the current -article. If thread-only is non-nil limit the summary buffer to +article. If thread-only is non-nil limit the summary buffer to these articles." (interactive (list (mail-header-id (gnus-summary-article-header)))) (let ((articles (gnus-articles-in-thread @@ -9080,14 +9080,14 @@ Return the number of articles fetched." result)) (defun gnus-summary-refer-thread (&optional limit) - "Fetch all articles in the current thread. For backends that -know how to search for threads (currently only 'nnimap) a -non-numeric prefix arg will use nnir to search the entire + "Fetch all articles in the current thread. For backends +that know how to search for threads (currently only 'nnimap) +a non-numeric prefix arg will use nnir to search the entire server; without a prefix arg only the current group is -searched. If the variable `gnus-refer-thread-use-nnir' is -non-nil the prefix arg has the reverse meaning. If no +searched. If the variable `gnus-refer-thread-use-nnir' is +non-nil the prefix arg has the reverse meaning. If no backend-specific 'request-thread function is available fetch -LIMIT (the numerical prefix) old headers. If LIMIT is +LIMIT (the numerical prefix) old headers. If LIMIT is non-numeric or nil fetch the number specified by the `gnus-refer-thread-limit' variable." (interactive "P") @@ -9647,8 +9647,8 @@ The search stars on the current article and goes forwards unless BACKWARD is non-nil. If BACKWARD is `all', do all articles. If UNREAD is non-nil, only unread articles will be taken into consideration. If NOT-CASE-FOLD, case won't be folded -in the comparisons. If NOT-MATCHING, return a list of all articles that -not match REGEXP on HEADER." +in the comparisons. If NOT-MATCHING, return a list of all articles +that not match REGEXP on HEADER." (let ((case-fold-search (not not-case-fold)) articles func) (if (consp header) diff --git a/lisp/gnus/gnus-util.el b/lisp/gnus/gnus-util.el index f73af8e261..6847d372cc 100644 --- a/lisp/gnus/gnus-util.el +++ b/lisp/gnus/gnus-util.el @@ -1610,7 +1610,7 @@ empty directories from OLD-PATH." (defun gnus-rescale-image (image size) "Rescale IMAGE to SIZE if possible. -SIZE is in format (WIDTH . HEIGHT). Return a new image. +SIZE is in format (WIDTH . HEIGHT). Return a new image. Sizes are in pixels." (if (not (fboundp 'imagemagick-types)) image diff --git a/lisp/gnus/gnus.el b/lisp/gnus/gnus.el index f990569a30..0673ac15f6 100644 --- a/lisp/gnus/gnus.el +++ b/lisp/gnus/gnus.el @@ -2733,15 +2733,15 @@ with some simple extensions. %O Download mark (character). %* If present, indicates desired cursor position (instead of after first colon). -%u User defined specifier. The next character in the - format string should be a letter. Gnus will call the +%u User defined specifier. The next character in the + format string should be a letter. Gnus will call the function gnus-user-format-function-X, where X is the - letter following %u. The function will be passed the - current header as argument. The function should + letter following %u. The function will be passed the + current header as argument. The function should return a string, which will be inserted into the summary just like information from any other summary specifier. -&user-date; Age sensitive date format. Various date format is +&user-date; Age sensitive date format. Various date format is defined in `gnus-user-date-format-alist'. @@ -4055,10 +4055,10 @@ Allow completion over sensible values." ;;;###autoload (defun gnus-no-server (&optional arg slave) "Read network news. -If ARG is a positive number, Gnus will use that as the startup -level. If ARG is nil, Gnus will be started at level 2. If ARG is -non-nil and not a positive number, Gnus will prompt the user for the -name of an NNTP server to use. +If ARG is a positive number, Gnus will use that as the startup level. +If ARG is nil, Gnus will be started at level 2. If ARG is non-nil +and not a positive number, Gnus will prompt the user for the name of +an NNTP server to use. As opposed to `gnus', this command will not connect to the local server." (interactive "P") diff --git a/lisp/gnus/mail-source.el b/lisp/gnus/mail-source.el index 69ecde3027..fab0f5296d 100644 --- a/lisp/gnus/mail-source.el +++ b/lisp/gnus/mail-source.el @@ -286,7 +286,7 @@ number." :type 'boolean) (defcustom mail-source-incoming-file-prefix "Incoming" - "Prefix for file name for storing incoming mail" + "Prefix for file name for storing incoming mail." :group 'mail-source :type 'string) diff --git a/lisp/gnus/message.el b/lisp/gnus/message.el index 9e0f2b461e..ef6455ac5c 100644 --- a/lisp/gnus/message.el +++ b/lisp/gnus/message.el @@ -1131,8 +1131,8 @@ If `traditional', reply inline. If `above', reply above quoted text. If `below', reply below quoted text. -Note: Many newsgroups frown upon nontraditional reply styles. You -probably want to set this variable only for specific groups, +Note: Many newsgroups frown upon nontraditional reply styles. +You probably want to set this variable only for specific groups, e.g. using `gnus-posting-styles': (eval (set (make-local-variable \\='message-cite-reply-position) \\='above))" @@ -1169,7 +1169,7 @@ use in `gnus-posting-styles', such as: (message-yank-cited-prefix "") (message-yank-empty-prefix "") (message-citation-line-format "\n\n-----------------------\nOn %a, %b %d %Y, %N wrote:\n")) - "Message citation style used by MS Outlook. Use with message-cite-style.") + "Message citation style used by MS Outlook. Use with `message-cite-style'.") (defconst message-cite-style-thunderbird '((message-cite-function 'message-cite-original) @@ -1179,7 +1179,7 @@ use in `gnus-posting-styles', such as: (message-yank-cited-prefix ">") (message-yank-empty-prefix ">") (message-citation-line-format "On %D %R %p, %N wrote:")) - "Message citation style used by Mozilla Thunderbird. Use with message-cite-style.") + "Message citation style used by Mozilla Thunderbird. Use with `message-cite-style'.") (defconst message-cite-style-gmail '((message-cite-function 'message-cite-original) @@ -1189,7 +1189,7 @@ use in `gnus-posting-styles', such as: (message-yank-cited-prefix " ") (message-yank-empty-prefix " ") (message-citation-line-format "On %e %B %Y %R, %f wrote:\n")) - "Message citation style used by Gmail. Use with message-cite-style.") + "Message citation style used by Gmail. Use with `message-cite-style'.") (defcustom message-distribution-function nil "Function called to return a Distribution header." @@ -4511,8 +4511,8 @@ smaller pieces, the size of each is about " one. However, some mail readers (MUA's) can't read split messages, i.e., -mails in message/partially format. Answer `n', and the message will be -sent in one piece. +mails in message/partially format. Answer `n', and the message +will be sent in one piece. The size limit is controlled by `message-send-mail-partially-limit'. If you always want Gnus to send messages in one piece, set diff --git a/lisp/gnus/mm-extern.el b/lisp/gnus/mm-extern.el index c3054432d5..d838cdc875 100644 --- a/lisp/gnus/mm-extern.el +++ b/lisp/gnus/mm-extern.el @@ -144,7 +144,7 @@ "Show the external-body part of HANDLE. This function replaces the buffer of HANDLE with a buffer contains the entire message. -If NO-DISPLAY is nil, display it. Otherwise, do nothing after replacing." +If NO-DISPLAY is nil, display it. Otherwise, do nothing after replacing." (unless (mm-handle-cache handle) (mm-extern-cache-contents handle)) (unless no-display diff --git a/lisp/gnus/mm-partial.el b/lisp/gnus/mm-partial.el index c68ab4a7c1..d2f279e419 100644 --- a/lisp/gnus/mm-partial.el +++ b/lisp/gnus/mm-partial.el @@ -54,7 +54,7 @@ "Show the partial part of HANDLE. This function replaces the buffer of HANDLE with a buffer contains the entire message. -If NO-DISPLAY is nil, display it. Otherwise, do nothing after replacing." +If NO-DISPLAY is nil, display it. Otherwise, do nothing after replacing." (let ((id (cdr (assq 'id (cdr (mm-handle-type handle))))) phandles (b (point)) (n 1) total diff --git a/lisp/gnus/mml-sec.el b/lisp/gnus/mml-sec.el index e0ec829617..716e4b778e 100644 --- a/lisp/gnus/mml-sec.el +++ b/lisp/gnus/mml-sec.el @@ -364,7 +364,7 @@ either an error is raised or not." (defun mml-secure-message-sign (&optional method) "Add MML tags to sign the entire message. -Use METHOD if given. Else use `mml-secure-method' or +Use METHOD if given. Else use `mml-secure-method' or `mml-default-sign-method'." (interactive) (mml-secure-message @@ -373,7 +373,7 @@ Use METHOD if given. Else use `mml-secure-method' or (defun mml-secure-message-sign-encrypt (&optional method) "Add MML tag to sign and encrypt the entire message. -Use METHOD if given. Else use `mml-secure-method' or +Use METHOD if given. Else use `mml-secure-method' or `mml-default-sign-method'." (interactive) (mml-secure-message @@ -382,7 +382,7 @@ Use METHOD if given. Else use `mml-secure-method' or (defun mml-secure-message-encrypt (&optional method) "Add MML tag to encrypt the entire message. -Use METHOD if given. Else use `mml-secure-method' or +Use METHOD if given. Else use `mml-secure-method' or `mml-default-sign-method'." (interactive) (mml-secure-message diff --git a/lisp/gnus/mml2015.el b/lisp/gnus/mml2015.el index d7876a3aef..45164ee8f6 100644 --- a/lisp/gnus/mml2015.el +++ b/lisp/gnus/mml2015.el @@ -760,7 +760,7 @@ If set, it overrides the setting of `mml2015-sign-with-sender'." (autoload 'epa-select-keys "epa") (defun mml2015-epg-key-image (key-id) - "Return the image of a key, if any" + "Return the image of a key, if any." (with-temp-buffer (set-buffer-multibyte nil) (let* ((coding-system-for-write 'binary) @@ -777,7 +777,7 @@ If set, it overrides the setting of `mml2015-sign-with-sender'." (autoload 'gnus-rescale-image "gnus-util") (defun mml2015-epg-key-image-to-string (key-id) - "Return a string with the image of a key, if any" + "Return a string with the image of a key, if any." (let ((key-image (mml2015-epg-key-image key-id))) (if (not key-image) "" diff --git a/lisp/gnus/nndiary.el b/lisp/gnus/nndiary.el index 8cda5aa703..f79d8f1707 100644 --- a/lisp/gnus/nndiary.el +++ b/lisp/gnus/nndiary.el @@ -121,7 +121,7 @@ Diary articles will appear again, as if they'd been just received. Entries look like (3 . day) which means something like \"Please Hortense, would you be so kind as to remind me of my appointments 3 days -before the date, thank you very much. Anda, hmmm... by the way, are you +before the date, thank you very much. Anda, hmmm... by the way, are you doing anything special tonight ?\". The units of measure are 'minute 'hour 'day 'week 'month and 'year (no, @@ -218,7 +218,7 @@ The hook functions will be called with the article in the current buffer." (defvoo nndiary-get-new-mail nil "Whether nndiary gets new mail and split it. Contrary to traditional mail back ends, this variable can be set to t -even if your primary mail back end also retrieves mail. In such a case, +even if your primary mail back end also retrieves mail. In such a case, NDiary uses its own mail-sources and split-methods.") (defvoo nndiary-nov-is-evil nil diff --git a/lisp/gnus/nnheader.el b/lisp/gnus/nnheader.el index c87cfc8c7c..28c4cebb2d 100644 --- a/lisp/gnus/nnheader.el +++ b/lisp/gnus/nnheader.el @@ -661,7 +661,7 @@ the line could be found." (defvar nnheader-directory-files-is-safe (not (eq system-type 'windows-nt)) "If non-nil, Gnus believes `directory-files' is safe. It has been reported numerous times that `directory-files' fails with -an alarming frequency on NFS mounted file systems. If it is nil, +an alarming frequency on NFS mounted file systems. If it is nil, `nnheader-directory-files-safe' is used.") (defun nnheader-directory-files-safe (&rest args) diff --git a/lisp/gnus/nnir.el b/lisp/gnus/nnir.el index d66bdf4706..b695cfa4f6 100644 --- a/lisp/gnus/nnir.el +++ b/lisp/gnus/nnir.el @@ -189,7 +189,7 @@ "Internal: stores search result.") (defvar nnir-search-history () - "Internal: the history for querying search options in nnir") + "Internal: the history for querying search options in nnir.") (defconst nnir-tmp-buffer " *nnir*" "Internal: temporary buffer.") @@ -208,8 +208,8 @@ (defvar nnir-imap-search-other "HEADER %S" "The IMAP search item to use for anything other than - `nnir-imap-search-arguments'. By default this is the name of an - email header field") +`nnir-imap-search-arguments'. By default this is the name of an +email header field.") (defvar nnir-imap-search-argument-history () "The history for querying search options in nnir") @@ -219,48 +219,48 @@ ;; Data type article list. (defmacro nnir-artlist-length (artlist) - "Returns number of articles in artlist." + "Return number of articles in artlist." `(length ,artlist)) (defmacro nnir-artlist-article (artlist n) - "Returns from ARTLIST the Nth artitem (counting starting at 1)." + "Return from ARTLIST the Nth artitem (counting starting at 1)." `(when (> ,n 0) (elt ,artlist (1- ,n)))) (defmacro nnir-artitem-group (artitem) - "Returns the group from the ARTITEM." + "Return the group from the ARTITEM." `(elt ,artitem 0)) (defmacro nnir-artitem-number (artitem) - "Returns the number from the ARTITEM." + "Return the number from the ARTITEM." `(elt ,artitem 1)) (defmacro nnir-artitem-rsv (artitem) - "Returns the Retrieval Status Value (RSV, score) from the ARTITEM." + "Return the Retrieval Status Value (RSV, score) from the ARTITEM." `(elt ,artitem 2)) (defmacro nnir-article-group (article) - "Returns the group for ARTICLE" + "Return the group for ARTICLE." `(nnir-artitem-group (nnir-artlist-article nnir-artlist ,article))) (defmacro nnir-article-number (article) - "Returns the number for ARTICLE" + "Return the number for ARTICLE." `(nnir-artitem-number (nnir-artlist-article nnir-artlist ,article))) (defmacro nnir-article-rsv (article) - "Returns the rsv for ARTICLE" + "Return the rsv for ARTICLE." `(nnir-artitem-rsv (nnir-artlist-article nnir-artlist ,article))) (defsubst nnir-article-ids (article) - "Returns the pair `(nnir id . real id)' of ARTICLE" + "Return the pair `(nnir id . real id)' of ARTICLE." (cons article (nnir-article-number article))) (defmacro nnir-categorize (sequence keyfunc &optional valuefunc) - "Sorts a sequence into categories and returns a list of the form + "Sort a sequence into categories and returns a list of the form `((key1 (element11 element12)) (key2 (element21 element22))'. The category key for a member of the sequence is obtained as `(keyfunc member)' and the corresponding element is just -`member'. If `valuefunc' is non-nil, the element of the list +`member'. If `valuefunc' is non-nil, the element of the list is `(valuefunc member)'." `(unless (null ,sequence) (let (value) @@ -317,7 +317,7 @@ If nil this will use `gnus-summary-line-format'." (defcustom nnir-retrieve-headers-override-function nil "If non-nil, a function that accepts an article list and group and populates the `nntp-server-buffer' with the retrieved -headers. Must return either 'nov or 'headers indicating the +headers. Must return either 'nov or 'headers indicating the retrieved header format. If this variable is nil, or if the provided function returns nil for a search @@ -327,8 +327,8 @@ result, `gnus-retrieve-headers' will be called instead." :group 'nnir) (defcustom nnir-imap-default-search-key "whole message" - "The default IMAP search key for an nnir search. Must be one of - the keys in `nnir-imap-search-arguments'. To use raw imap queries + "The default IMAP search key for an nnir search. Must be one of + the keys in `nnir-imap-search-arguments'. To use raw imap queries by default set this to \"imap\"." :version "24.1" :type `(choice ,@(mapcar (lambda (elem) (list 'const (car elem))) @@ -428,7 +428,7 @@ This could be a server parameter." (defcustom nnir-hyrex-additional-switches '() "A list of strings, to be given as additional arguments for nnir-search. -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 nnir-hyrex-additional-switches \"-ddl ddl.xml -c nnir\") ; wrong ! Instead, use this: (setq nnir-hyrex-additional-switches \\='(\"-ddl\" \"ddl.xml\" \"-c\" \"nnir\"))" @@ -600,8 +600,8 @@ the groups to search as follows: if called from the *Server* buffer search all groups belonging to the server on the current line; if called from the *Group* buffer search any marked groups, or the group on the current line, or all the groups under the -current topic. Calling with a prefix-arg prompts for additional -search-engine specific constraints. A non-nil `specs' arg must be +current topic. Calling with a prefix-arg prompts for additional +search-engine specific constraints. A non-nil `specs' arg must be an alist with `nnir-query-spec' and `nnir-group-spec' keys, and skips all prompting." (interactive "P") @@ -1456,8 +1456,9 @@ Tested with swish-e-2.0.1 on Windows NT 4.0." ;; Namazu interface (defun nnir-run-namazu (query server &optional _group) - "Run given query against Namazu. Returns a vector of (group name, file name) -pairs (also vectors, actually). + "Run given query against Namazu. +Returns a vector of (group name, file name) pairs (also vectors, +actually). Tested with Namazu 2.0.6 on a GNU/Linux system." ;; (when group @@ -1702,12 +1703,12 @@ construct path: search terms (see the variable (and group (string-match "^nnir" group)))) (defun nnir-read-parms (nnir-search-engine) - "Reads additional search parameters according to `nnir-engines'." + "Read additional search parameters according to `nnir-engines'." (let ((parmspec (nth 2 (assoc nnir-search-engine nnir-engines)))) (mapcar #'nnir-read-parm parmspec))) (defun nnir-read-parm (parmspec) - "Reads a single search parameter. + "Read a single search parameter. `parmspec' is a cons cell, the car is a symbol, the cdr is a prompt." (let ((sym (car parmspec)) (prompt (cdr parmspec))) @@ -1737,8 +1738,8 @@ construct path: search terms (see the variable nnir-method-default-engines)))) (defun nnir-read-server-parm (key server &optional not-global) - "Returns the parameter value corresponding to `key' for -`server'. If no server-specific value is found consult the global + "Return the parameter value corresponding to `key' for `server'. +If no server-specific value is found consult the global environment unless `not-global' is non-nil." (let ((method (gnus-server-to-method server))) (cond ((and method (assq key (cddr method))) @@ -1763,7 +1764,7 @@ environment unless `not-global' is non-nil." (defun nnir-search-thread (header) "Make an nnir group based on the thread containing the article -header. The current server will be searched. If the registry is +header. The current server will be searched. If the registry is installed, the server that the registry reports the current article came from is also searched." (let* ((query diff --git a/lisp/gnus/nnmairix.el b/lisp/gnus/nnmairix.el index 53275e1964..6c5502ac3d 100644 --- a/lisp/gnus/nnmairix.el +++ b/lisp/gnus/nnmairix.el @@ -381,7 +381,7 @@ 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 + "Default search group. This is the group which is used for all temporary searches, e.g. nnmairix-search.") ;;; === Internal variables @@ -1096,7 +1096,7 @@ show wrong article counts." (defun nnmairix-propagate-marks (&optional server) "Propagate marks from nnmairix group to original articles. Unless SERVER is explicitly specified, will use the last opened -nnmairix server. Only marks from current session will be set." +nnmairix server. Only marks from current session will be set." (interactive) (if server (nnmairix-open-server server) diff --git a/lisp/gnus/smime.el b/lisp/gnus/smime.el index 9a38a6c697..b7ec033603 100644 --- a/lisp/gnus/smime.el +++ b/lisp/gnus/smime.el @@ -130,7 +130,7 @@ (defcustom smime-keys nil "Map mail addresses to a file containing Certificate (and private key). -The file is assumed to be in PEM format. You can also associate additional +The file is assumed to be in PEM format. You can also associate additional certificates to be sent with every message to each address." :type '(repeat (list (string :tag "Mail address") (file :tag "File name") @@ -197,7 +197,7 @@ against a certificate revocation list (CRL). For this to work the CRL must be up-to-date and since they are normally updated quite often (i.e., several times a day) you -probably need some tool to keep them up-to-date. Unfortunately +probably need some tool to keep them up-to-date. Unfortunately Gnus cannot do this for you. The CRL should either be appended (in PEM format) to your @@ -435,7 +435,7 @@ in the buffer specified by `smime-details-buffer'." (defun smime-verify-buffer (&optional buffer) "Verify integrity of S/MIME message in BUFFER. -Uses current buffer if BUFFER is nil. Returns non-nil on success. +Uses current buffer if BUFFER is nil. Returns non-nil on success. Any details (stdout and stderr) are left in the buffer specified by `smime-details-buffer'." (interactive) @@ -445,7 +445,7 @@ Any details (stdout and stderr) are left in the buffer specified by (defun smime-noverify-buffer (&optional buffer) "Verify integrity of S/MIME message in BUFFER. Does NOT verify validity of certificate (only message integrity). -Uses current buffer if BUFFER is nil. Returns non-nil on success. +Uses current buffer if BUFFER is nil. Returns non-nil on success. Any details (stdout and stderr) are left in the buffer specified by `smime-details-buffer'." (interactive) diff --git a/lisp/gnus/spam-report.el b/lisp/gnus/spam-report.el index f611a213fd..b93d405ec1 100644 --- a/lisp/gnus/spam-report.el +++ b/lisp/gnus/spam-report.el @@ -318,9 +318,9 @@ symbol `ask', query before flushing the queue file." ;;;###autoload (defun spam-report-url-ping-mm-url (host report) - "Ping a host through HTTP, addressing a specific GET resource. Use -the external program specified in `mm-url-program' to connect to -server." + "Ping a host through HTTP, addressing a specific GET resource. +Use the external program specified in `mm-url-program' to connect +to server." (with-temp-buffer (let ((url (format "http://%s%s" host report))) (mm-url-insert url t)))) diff --git a/lisp/gnus/spam.el b/lisp/gnus/spam.el index f990e0cba1..c701e314fc 100644 --- a/lisp/gnus/spam.el +++ b/lisp/gnus/spam.el @@ -578,12 +578,12 @@ This must be a list. For example, `(\"-C\" \"configfile\")'." (defcustom spam-spamassassin-positive-spam-flag-header "YES" "The regex on `spam-spamassassin-spam-flag-header' for positive spam -identification" +identification." :type 'string :group 'spam-spamassassin) (defcustom spam-spamassassin-spam-status-header "X-Spam-Status" - "The header inserted by SpamAssassin, giving extended scoring information" + "The header inserted by SpamAssassin, giving extended scoring information." :type 'string :group 'spam-spamassassin) @@ -594,7 +594,7 @@ identification" :group 'spam-spamassassin) (defcustom spam-sa-learn-rebuild t - "Whether sa-learn should rebuild the database every time it is called + "Whether sa-learn should rebuild the database every time it is called. Enable this if you want sa-learn to rebuild the database automatically. Doing this will slightly increase the running time of the spam registration process. If you choose not to do this, you will have to run \"sa-learn --rebuild\" in @@ -767,7 +767,7 @@ When either list is nil, the other is returned." nil)) (defun spam-classifications () - "Return list of valid classifications" + "Return list of valid classifications." '(spam ham)) (defun spam-classification-valid-p (classification) @@ -2185,7 +2185,7 @@ Uses `gnus-newsgroup-name' if category is nil (for ham registration)." (require 'spam-stat) (defun spam-check-stat () - "Check the spam-stat backend for the classification of this message" + "Check the spam-stat backend for the classification of this message." (let ((spam-stat-split-fancy-spam-group spam-split-group) ; override (spam-stat-buffer (buffer-name)) ; stat the current buffer category return) @@ -2609,7 +2609,7 @@ With a non-nil REMOVE, remove the ADDRESSES." ;; return something sensible if the score can't be determined (defun spam-spamassassin-score (&optional recheck) - "Get the SpamAssassin score" + "Get the SpamAssassin score." (interactive "P") (save-window-excursion (gnus-summary-show-article t) diff --git a/lisp/help.el b/lisp/help.el index e40178de96..1ae4b2c38d 100644 --- a/lisp/help.el +++ b/lisp/help.el @@ -1022,7 +1022,7 @@ appeared on the mode-line." (delq nil (mapcar 'symbol-name minor-mode-list))) (defun describe-minor-mode-from-symbol (symbol) - "Display documentation of a minor mode given as a symbol, SYMBOL" + "Display documentation of a minor mode given as a symbol, SYMBOL." (interactive (list (intern (completing-read "Minor mode symbol: " (describe-minor-mode-completion-table-for-symbol))))) diff --git a/lisp/hippie-exp.el b/lisp/hippie-exp.el index 404f448e0d..89d1342fbe 100644 --- a/lisp/hippie-exp.el +++ b/lisp/hippie-exp.el @@ -248,7 +248,7 @@ If nil, all buffers are searched." (defcustom hippie-expand-ignore-buffers '("^ \\*.*\\*$" dired-mode) "A list specifying which buffers not to search (if not current). Can contain both regexps matching buffer names (as strings) and major modes -\(as atoms)" +\(as atoms)." :type '(repeat (choice regexp (symbol :tag "Major Mode"))) :group 'hippie-expand) diff --git a/lisp/htmlfontify.el b/lisp/htmlfontify.el index c1aaab5e21..481b14738b 100644 --- a/lisp/htmlfontify.el +++ b/lisp/htmlfontify.el @@ -460,7 +460,7 @@ and so on." keep-overlays : More of a bell (or possibly whistle) than an optimization - If on, preserve overlay highlighting (cf ediff or goo-font-lock) as well as basic faces.\n - body-text-only : Emit only body-text. In concrete terms, + body-text-only : Emit only body-text. In concrete terms, 1. Suppress calls to `hfy-page-header' and `hfy-page-footer' 2. Pretend that `div-wrapper' option above is @@ -1066,7 +1066,7 @@ haven't encountered them yet. Returns a `hfy-style-assoc'." (defun hfy-face-resolve-face (fn) "For FN return a face specification. -FN may be either a face or a face specification. If the latter, +FN may be either a face or a face specification. If the latter, then the specification is returned unchanged." (cond ((facep fn) @@ -1593,8 +1593,8 @@ Do not record undo information during evaluation of BODY." (defun hfy-begin-span (style text-block text-id text-begins-block-p) "Default handler to begin a span of text. -Insert \"\". See -`hfy-begin-span-handler' for more information." +Insert \"\". +See `hfy-begin-span-handler' for more information." (when text-begins-block-p (insert (format "…" text-block))) diff --git a/lisp/ibuf-ext.el b/lisp/ibuf-ext.el index 06a2248d40..2746e4115a 100644 --- a/lisp/ibuf-ext.el +++ b/lisp/ibuf-ext.el @@ -127,12 +127,12 @@ Buffers whose major mode is in this list, are not searched." (defvar ibuffer-auto-buffers-changed nil) (defun ibuffer-update-saved-filters-format (filters) - "Transforms alist from old to new `ibuffer-saved-filters' format. + "Transform alist from old to new `ibuffer-saved-filters' format. Specifically, converts old-format alist with values of the form (STRING (FILTER-SPECS...)) to alist with values of the form (STRING FILTER-SPECS...), where each filter spec should be a -cons cell with a symbol in the car. Any elements in the latter +cons cell with a symbol in the car. Any elements in the latter form are kept as is. Returns (OLD-FORMAT-DETECTED . UPDATED-SAVED-FILTERS-LIST)." @@ -178,14 +178,14 @@ Returns (OLD-FORMAT-DETECTED . UPDATED-SAVED-FILTERS-LIST)." Each element should look like (\"NAME\" . FILTER-LIST), where FILTER-LIST has the same structure as the variable -`ibuffer-filtering-qualifiers', which see. The filters defined +`ibuffer-filtering-qualifiers', which see. The filters defined here are joined with an implicit logical `and' and associated -with NAME. The combined specification can be used by name in +with NAME. The combined specification can be used by name in other filter specifications via the `saved' qualifier (again, see `ibuffer-filtering-qualifiers'). They can also be switched to by name (see the functions `ibuffer-switch-to-saved-filters' and -`ibuffer-save-filters'). The variable `ibuffer-save-with-custom' -affects how this information is saved for future sessions. This +`ibuffer-save-filters'). The variable `ibuffer-save-with-custom' +affects how this information is saved for future sessions. This variable can be set directly from lisp code." :version "26.1" :type '(alist :key-type (string :tag "Filter name") @@ -213,14 +213,14 @@ either clicking or hitting return " (customize-save-variable 'ibuffer-saved-filters ibuffer-saved-filters) (message "Saved updated ibuffer-saved-filters.")))) - ". See below for + ". See below for an explanation and alternative ways to save the repaired value. Explanation: For the list variable `ibuffer-saved-filters', elements of the form (STRING (FILTER-SPECS...)) are deprecated and should instead have the form (STRING FILTER-SPECS...), where -each filter spec is a cons cell with a symbol in the car. See -`ibuffer-saved-filters' for details. The repaired value fixes +each filter spec is a cons cell with a symbol in the car. See +`ibuffer-saved-filters' for details. The repaired value fixes this format without changing the meaning of the saved filters. Alternative ways to save the repaired value: @@ -238,7 +238,7 @@ Alternative ways to save the repaired value: "A list specifying the filters currently acting on the buffer list. If this list is nil, then no filters are currently in -effect. Otherwise, each element of this list specifies a single +effect. Otherwise, each element of this list specifies a single filter, and all of the specified filters in the list are applied successively to the buffer list. @@ -273,7 +273,7 @@ A compound filter specification can have one of four forms: -- (saved . \"NAME\") Represents the filter saved under the string NAME - in the alist `ibuffer-saved-filters'. It is an + in the alist `ibuffer-saved-filters'. It is an error to name a filter that has not been saved. This variable is local to each ibuffer buffer.") @@ -363,12 +363,12 @@ Currently, this only applies to `ibuffer-saved-filters' and :group 'ibuffer) (defun ibuffer-repair-saved-filters () - "Updates `ibuffer-saved-filters' to its new-style format, if needed. + "Update `ibuffer-saved-filters' to its new-style format, if needed. If this list has any elements of the old-style format, a deprecation warning is raised, with a button allowing persistent -update. Any updated filters retain their meaning in the new -format. See `ibuffer-update-saved-filters-format' and +update. Any updated filters retain their meaning in the new +format. See `ibuffer-update-saved-filters-format' and `ibuffer-saved-filters' for details of the old and new formats." (interactive) (when (and (boundp 'ibuffer-saved-filters) ibuffer-saved-filters) @@ -560,8 +560,8 @@ format. See `ibuffer-update-saved-filters-format' and ;;;###autoload (autoload 'ibuffer-do-eval "ibuf-ext") (define-ibuffer-op eval (form) "Evaluate FORM in each of the buffers. -Does not display the buffer during evaluation. See -`ibuffer-do-view-and-eval' for that." +Does not display the buffer during evaluation. +See `ibuffer-do-view-and-eval' for that." (:interactive (list (read-from-minibuffer @@ -697,10 +697,10 @@ specifications with the same structure as filters)))) (defun ibuffer-unary-operand (filter) - "Extracts operand from a unary compound FILTER specification. + "Extract operand from a unary compound FILTER specification. FILTER should be a cons cell of either form (f . d) or (f d), -where operand d is itself a cons cell, or nil. Returns d." +where operand d is itself a cons cell, or nil. Returns d." (let* ((tail (cdr filter)) (maybe-q (car-safe tail))) (if (consp maybe-q) maybe-q tail))) @@ -1337,7 +1337,7 @@ matches against 'c.d'." "Limit current view to buffers with filename extension matching QUALIFIER. The separator character (typically `.') is not part of the -pattern. For example, for a buffer associated with file +pattern. For example, for a buffer associated with file '/a/b/c.d', this matches against 'd'." (:description "filename extension" :reader (read-from-minibuffer @@ -1350,7 +1350,7 @@ pattern. For example, for a buffer associated with file "Limit current view to buffers with directory matching QUALIFIER. For a buffer associated with file '/a/b/c.d', this matches -against '/a/b'. For a buffer not associated with a file, this +against '/a/b'. For a buffer not associated with a file, this matches against the value of `default-directory' in that buffer." (:description "directory name" :reader (read-from-minibuffer "Filter by directory name (regex): ")) diff --git a/lisp/image-dired.el b/lisp/image-dired.el index c9b31e9f1f..c1c767ba78 100644 --- a/lisp/image-dired.el +++ b/lisp/image-dired.el @@ -298,7 +298,7 @@ with the information required by the Thumbnail Managing Standard." "Arguments for `image-dired-cmd-pngcrush-program'. Available format specifiers are the same as in `image-dired-cmd-create-thumbnail-options', with %q for a -temporary file name (typically generated by pnqnq)" +temporary file name (typically generated by pnqnq)." :version "26.1" :type '(repeat (string :tag "Argument")) :group 'image-dired) diff --git a/lisp/image-mode.el b/lisp/image-mode.el index 9c7c91eb58..fae928f4e6 100644 --- a/lisp/image-mode.el +++ b/lisp/image-mode.el @@ -809,7 +809,7 @@ was inserted." If the current buffer is displaying an image file as an image, call `image-mode-as-text' to switch to text or hex display. -Otherwise, display the image by calling `image-mode'" +Otherwise, display the image by calling `image-mode'." (interactive) (if (image-get-display-property) (image-mode-as-text) diff --git a/lisp/international/ccl.el b/lisp/international/ccl.el index 51626f5161..fb866fe354 100644 --- a/lisp/international/ccl.el +++ b/lisp/international/ccl.el @@ -813,7 +813,7 @@ is a list of CCL-BLOCKs." t) (defun ccl-compile-read-multibyte-character (cmd) - "Compile read-multibyte-character" + "Compile read-multibyte-character." (if (/= (length cmd) 3) (error "CCL: Invalid number of arguments: %s" cmd)) (let ((RRR (nth 1 cmd)) @@ -824,7 +824,7 @@ is a list of CCL-BLOCKs." nil) (defun ccl-compile-write-multibyte-character (cmd) - "Compile write-multibyte-character" + "Compile write-multibyte-character." (if (/= (length cmd) 3) (error "CCL: Invalid number of arguments: %s" cmd)) (let ((RRR (nth 1 cmd)) diff --git a/lisp/international/kkc.el b/lisp/international/kkc.el index 437971742d..8e62a2d1cc 100644 --- a/lisp/international/kkc.el +++ b/lisp/international/kkc.el @@ -59,7 +59,7 @@ This string is shown at mode line when users are in KKC mode.") (defconst kkc-lookup-cache-tag 'kkc-lookup-cache-2) (defun kkc-save-init-file () - "Save initial setup code for KKC to a file specified by `kkc-init-file-name'" + "Save initial setup code for KKC to a file specified by `kkc-init-file-name'." (if (and kkc-init-file-flag (not (eq kkc-init-file-flag t))) (let ((coding-system-for-write 'iso-2022-7bit) diff --git a/lisp/international/latin1-disp.el b/lisp/international/latin1-disp.el index 1b7bc49a6b..67347f3e0d 100644 --- a/lisp/international/latin1-disp.el +++ b/lisp/international/latin1-disp.el @@ -97,7 +97,7 @@ use either \\[customize] or the function `latin1-display'." "Set up Latin-1/ASCII display for the arguments character SETS. See option `latin1-display' for the method. The members of the list must be in `latin1-display-sets'. With no arguments, reset the -display for all of `latin1-display-sets'. See also +display for all of `latin1-display-sets'. See also `latin1-display-setup'." (if sets (progn diff --git a/lisp/international/ogonek.el b/lisp/international/ogonek.el index 543f2e3388..594d0a0765 100644 --- a/lisp/international/ogonek.el +++ b/lisp/international/ogonek.el @@ -62,8 +62,8 @@ 136 141 171 184 196 151 230 144 253)) ) "The constant `ogonek-name-encoding-alist' is a list of (NAME.LIST) pairs. -Each LIST contains codes for 18 Polish diacritic characters. The codes -are given in the following order: +Each LIST contains codes for 18 Polish diacritic characters. +The codes are given in the following order: Aogonek Cacute Eogonek Lslash Nacute Oacute Sacute Zacute Zdotaccent aogonek cacute eogonek lslash nacute oacute sacute zacute zdotaccent.") @@ -173,7 +173,7 @@ znak/ow diakrytycznych. Funkcje te mo/zna pogrupowa/c nast/epuj/aco. " THE INTERACTIVE FUNCTIONS PROVIDED BY THE LIBRARY `ogonek'. If you read this text then you are either looking at the library's -source text or you have called the `ogonek-how' command. In the +source text or you have called the `ogonek-how' command. In the latter case you may remove this text using `\\[kill-buffer]'. The library provides functions for changing the encoding of Polish @@ -182,13 +182,13 @@ The functions come in the following groups. 1. `ogonek-recode-region' and `ogonek-recode-buffer' to change between one-character encodings, such as `iso-8859-2', `mazovia', - plain `ascii' or `TeX'. As the names suggest you may recode + plain `ascii' or `TeX'. As the names suggest you may recode either the entire current buffer or just a marked region - in it. You may use the functions interactively as commands. + in it. You may use the functions interactively as commands. Once you call a command you will be asked about the code currently used in your text and the target encoding, the one - you want to get. The following example shows a non-interactive - use of the functions in a program. This also illustrates what + you want to get. The following example shows a non-interactive + use of the functions in a program. This also illustrates what type of parameters the functions expect to be called with: (ogonek-recode-region @@ -210,11 +210,11 @@ The functions come in the following groups. (ogonek-prefixify-buffer prefix-char to-code-name) The TAB character used in interactive mode makes `emacs' - display the list of encodings recognized by the library. The list + display the list of encodings recognized by the library. The list is stored in the constant `ogonek-name-encoding-alist'. The `ogonek' functions refer to five variables in which the suggested - answers to dialogue questions are stored. The variables and their + answers to dialogue questions are stored. The variables and their default values are: ogonek-from-encoding iso8859-2 @@ -239,7 +239,7 @@ The functions come in the following groups. (autoload \\='ogonek-deprefixify-region \"ogonek\") The most frequent function calls can be abbreviated and assigned to - keyboard keys. Here are a few practical examples: + keyboard keys. Here are a few practical examples: (defun deprefixify-iso8859-2-region (start end) (interactive \"*r\") @@ -329,7 +329,7 @@ PROMPT is a string to be shown when the user is asked for a new prefix." (defun ogonek-lookup-encoding (encoding) "Pick up an association for ENCODING in `ogonek-name-encoding-alist'. Before returning a result test whether the string ENCODING is in -the list `ogonek-name-encoding-alist'" +the list `ogonek-name-encoding-alist'." (let ((code-list (assoc encoding ogonek-name-encoding-alist))) (if (null code-list) (error "! Name `%s' not known in `ogonek-name-encoding-alist'" @@ -449,8 +449,8 @@ PREFIX-CHAR itself gets doubled." (defun ogonek-deprefixify-region (start end prefix-char to-encoding) "In a region, replace PREFIX pairs with their corresponding TO-encodings. PREFIX-CHAR followed by a Polish character from the `ogonek-prefix-code' -list is replaced with the corresponding TO-encoded character. A doubled -PREFIX-CHAR gets replaced with a single one. A combination of PREFIX-CHAR +list is replaced with the corresponding TO-encoded character. A doubled +PREFIX-CHAR gets replaced with a single one. A combination of PREFIX-CHAR followed by a non-Polish character, that is one not listed in the `ogonek-prefix-code' constant, is left unchanged." (interactive (progn (barf-if-buffer-read-only) diff --git a/lisp/isearch.el b/lisp/isearch.el index ec51c2cf4c..1e4a87ff48 100644 --- a/lisp/isearch.el +++ b/lisp/isearch.el @@ -207,8 +207,8 @@ to the search status stack.") "Predicate to filter hits of Isearch and replace commands. Isearch hits that don't satisfy the predicate will be skipped. The value should be a function of two arguments; it will be -called with the the positions of the start and the end of the -text matched by Isearch and replace commands. If this function +called with the positions of the start and the end of the text +matched by Isearch and replace commands. If this function returns nil, Isearch and replace commands will continue searching without stopping at resp. replacing this match. @@ -2009,7 +2009,7 @@ Turning on character-folding turns off regexp mode.") "Text properties that are added to the isearch prompt.") (defun isearch--momentary-message (string) - "Print STRING at the end of the isearch prompt for 1 second" + "Print STRING at the end of the isearch prompt for 1 second." (let ((message-log-max nil)) (message "%s%s%s" (isearch-message-prefix nil isearch-nonincremental) diff --git a/lisp/jsonrpc.el b/lisp/jsonrpc.el index 85fd40ecd2..41cd84627b 100644 --- a/lisp/jsonrpc.el +++ b/lisp/jsonrpc.el @@ -107,7 +107,7 @@ notifications. CONN, METHOD and PARAMS are the same as in ;;; API mandatory (cl-defgeneric jsonrpc-connection-send (conn &key id method params result error) "Send a JSONRPC message to connection CONN. -ID, METHOD, PARAMS, RESULT and ERROR. ") +ID, METHOD, PARAMS, RESULT and ERROR.") ;;; API optional (cl-defgeneric jsonrpc-shutdown (conn) @@ -343,7 +343,7 @@ ignored." :documentation "Process object wrapped by the this connection.") (-expected-bytes :accessor jsonrpc--expected-bytes - :documentation "How many bytes declared by server") + :documentation "How many bytes declared by server.") (-on-shutdown :accessor jsonrpc--on-shutdown :initform #'ignore @@ -416,13 +416,13 @@ connection object, called when the process dies .") (cl-defmethod jsonrpc-shutdown ((conn jsonrpc-process-connection) &optional cleanup) "Wait for JSONRPC connection CONN to shutdown. -With optional CLEANUP, kill any associated buffers. " +With optional CLEANUP, kill any associated buffers." (unwind-protect (cl-loop with proc = (jsonrpc--process conn) for i from 0 while (not (process-get proc 'jsonrpc-sentinel-cleanup-started)) unless (zerop i) do - (jsonrpc--warn "Sentinel for %s still hasn't run, deleting it!" proc) + (jsonrpc--warn "Sentinel for %s still hasn't run, deleting it!" proc) do (delete-process proc) (accept-process-output nil 0.1)) @@ -574,8 +574,8 @@ With optional CLEANUP, kill any associated buffers. " (deferred nil)) "Does actual work for `jsonrpc-async-request'. -Return a list (ID TIMER). ID is the new request's ID, or nil if -the request was deferred. TIMER is a timer object set (or nil, if +Return a list (ID TIMER). ID is the new request's ID, or nil if +the request was deferred. TIMER is a timer object set (or nil, if TIMEOUT is nil)." (pcase-let* ((buf (current-buffer)) (point (point)) (`(,_ ,timer ,old-id) diff --git a/lisp/language/tibet-util.el b/lisp/language/tibet-util.el index 68faf2016a..912879eb38 100644 --- a/lisp/language/tibet-util.el +++ b/lisp/language/tibet-util.el @@ -54,7 +54,7 @@ ;;;###autoload (defun tibetan-char-p (ch) "Check if char CH is Tibetan character. -Returns non-nil if CH is Tibetan. Otherwise, returns nil." +Returns non-nil if CH is Tibetan. Otherwise, returns nil." (memq (char-charset ch) '(tibetan tibetan-1-column))) ;;; Functions for Tibetan <-> Tibetan-transcription. diff --git a/lisp/mail/feedmail.el b/lisp/mail/feedmail.el index b362614d3a..08db4262f1 100644 --- a/lisp/mail/feedmail.el +++ b/lisp/mail/feedmail.el @@ -1136,9 +1136,9 @@ they were placed in the queue." This variable is used by the default date generating function, feedmail-default-date-generator. If nil, the default, the last-modified timestamp of the queue file is used to create the -message Date: header; if there is no queue file, the current time is -used. If you are using VM, it might be supplying this header for -you. To suppress VM's version +message Date: header; if there is no queue file, the current time +is used. If you are using VM, it might be supplying this header +for you. To suppress VM's version (setq vm-mail-header-insert-date nil)" :group 'feedmail-queue @@ -1382,7 +1382,7 @@ It shows the simple addresses and gets a confirmation. Use as: When this hook runs, the current buffer is already the appropriate buffer. It has already had all the header prepping from the standard package. The next step after running the hook will be to save the -message via Fcc: processing. The hook might be interested in these: +message via Fcc: processing. The hook might be interested in these: \(1) `feedmail-prepped-text-buffer' contains the header and body of the message, ready to go; (2) `feedmail-address-list' contains a list of simplified recipients of addresses which are to be given to the @@ -1411,7 +1411,7 @@ can undo the encoding." "User's last opportunity to modify the message before Fcc action. It has already had all the header prepping from the standard package. The next step after running the hook will be to save the message via -Fcc: processing. The hook might be interested in these: (1) +Fcc: processing. The hook might be interested in these: (1) `feedmail-prepped-text-buffer' contains the header and body of the message, ready to go; (2) `feedmail-address-list' contains a list of simplified recipients of addressees to whom the message was sent (3) @@ -2361,7 +2361,7 @@ mapped to mostly alphanumerics for safety." ))) (defun feedmail-send-it-immediately-wrapper () - "Wrapper to catch skip-me-i" + "Wrapper to catch skip-me-i." (if (eq 'skip-me-i (catch 'skip-me-i (feedmail-send-it-immediately))) (error "FQM: Sending...abandoned!"))) @@ -3159,7 +3159,7 @@ been weeded out." (sit-for feedmail-queue-chatty-sit-for)))) (defun feedmail-find-eoh (&optional noerror) - "Internal; finds the end of message header fields, returns mark just before it" + "Internal; finds the end of message header fields, returns mark just before it." ;; all this funny business with line endings is to account for CRLF ;; weirdness that I don't think I'll ever figure out (feedmail-say-debug ">in-> feedmail-find-eoh %s" noerror) diff --git a/lisp/mail/hashcash.el b/lisp/mail/hashcash.el index 6068952997..185a7a7441 100644 --- a/lisp/mail/hashcash.el +++ b/lisp/mail/hashcash.el @@ -158,7 +158,7 @@ For example, you may want to set this to (\"-Z2\") to reduce header length." (or (nth 1 val) (nth 0 val) addr))) (defun hashcash-generate-payment (str val) - "Generate a hashcash payment by finding a VAL-bit collison on STR." + "Generate a hashcash payment by finding a VAL-bit collision on STR." (if (and (> val 0) hashcash-program) (with-current-buffer (get-buffer-create " *hashcash*") @@ -171,7 +171,7 @@ For example, you may want to set this to (\"-Z2\") to reduce header length." (error "No `hashcash' binary found"))) (defun hashcash-generate-payment-async (str val callback) - "Generate a hashcash payment by finding a VAL-bit collison on STR. + "Generate a hashcash payment by finding a VAL-bit collision on STR. Return immediately. Call CALLBACK with process and result when ready." (if (and (> val 0) hashcash-program) @@ -226,7 +226,7 @@ Return immediately. Call CALLBACK with process and result when ready." ;;;###autoload (defun hashcash-insert-payment (arg) - "Insert X-Payment and X-Hashcash headers with a payment for ARG" + "Insert X-Payment and X-Hashcash headers with a payment for ARG." (interactive "sPay to: ") (unless (hashcash-already-paid-p arg) (let ((pay (hashcash-generate-payment (hashcash-payment-to arg) @@ -294,7 +294,7 @@ BUFFER defaults to the current buffer." ;;;###autoload (defun hashcash-verify-payment (token &optional resource amount) - "Verify a hashcash payment" + "Verify a hashcash payment." (let* ((split (split-string token ":")) (key (if (< (hashcash-version token) 1.2) (nth 1 split) diff --git a/lisp/mail/rmail.el b/lisp/mail/rmail.el index 91291b8d33..93e7cb0133 100644 --- a/lisp/mail/rmail.el +++ b/lisp/mail/rmail.el @@ -285,7 +285,7 @@ Otherwise, look for `movemail' in the directories in (throw 'scan x)))))))))) (defvar rmail-movemail-variant-in-use nil - "The movemail variant currently in use. Known variants are: + "The movemail variant currently in use. Known variants are: `emacs' Means any implementation, compatible with the native Emacs one. This is the default; @@ -2308,7 +2308,7 @@ If nil, that means the current message." (defun rmail-get-attr-value (attr state) "Return the character value for ATTR. ATTR is a (numeric) index, an offset into the mbox attribute -header value. STATE is one of nil, t, or a character value." +header value. STATE is one of nil, t, or a character value." (cond ((numberp state) state) ((not state) ?-) diff --git a/lisp/mail/rmailmm.el b/lisp/mail/rmailmm.el index 95977e826d..6106183ac0 100644 --- a/lisp/mail/rmailmm.el +++ b/lisp/mail/rmailmm.el @@ -147,7 +147,7 @@ display HTML source." ;; Default to preferring HTML parts, but only if we have a renderer (if rmail-mime-render-html-function t nil) "If non-nil, default to showing HTML part rather than text part -when both are available" +when both are available." :group 'rmail :version "25.1" :type 'boolean) @@ -1391,8 +1391,8 @@ STATE forces a particular display state, rather than toggling. `raw' forces raw mode, any other non-nil value forces decoded mode. If `rmail-enable-mime' is nil, this creates a temporary \"*RMAIL*\" -buffer holding a decoded copy of the message. Inline content-types are -handled according to `rmail-mime-media-type-handlers-alist'. +buffer holding a decoded copy of the message. Inline content-types +are handled according to `rmail-mime-media-type-handlers-alist'. By default, this displays text and multipart messages, and offers to download attachments as specified by `rmail-mime-attachment-dirs-alist'. The arguments ARG and STATE have no effect in this case." diff --git a/lisp/mail/rmailsum.el b/lisp/mail/rmailsum.el index 79a322c1d9..eacfc1f829 100644 --- a/lisp/mail/rmailsum.el +++ b/lisp/mail/rmailsum.el @@ -1360,7 +1360,7 @@ move to the previous message." (defun rmail-summary-show-message (where) "Show current mail message. -Position it according to WHERE which can be BEG or END" +Position it according to WHERE which can be BEG or END." (if (and (one-window-p) (not pop-up-frames)) ;; If there is just one window, put the summary on the top. (let ((buffer rmail-buffer)) diff --git a/lisp/mail/supercite.el b/lisp/mail/supercite.el index ce00a7cf66..556e4b3923 100644 --- a/lisp/mail/supercite.el +++ b/lisp/mail/supercite.el @@ -1753,7 +1753,7 @@ entered, regardless of the value of `sc-electric-references-p'. See (defun sc-raw-mode-toggle () "Toggle, in one fell swoop, two important SC variables: -`sc-fixup-whitespace-p' and `sc-auto-fill-region-p'" +`sc-fixup-whitespace-p' and `sc-auto-fill-region-p'." (interactive) (setq sc-fixup-whitespace-p (not sc-fixup-whitespace-p) sc-auto-fill-region-p (not sc-auto-fill-region-p)) diff --git a/lisp/man.el b/lisp/man.el index cef3d598eb..9d21e953d1 100644 --- a/lisp/man.el +++ b/lisp/man.el @@ -1023,7 +1023,7 @@ names or descriptions. The pattern argument is usually an (man man-args))) (defmacro Man-start-calling (&rest body) - "Start the man command in `body' after setting up the environment" + "Start the man command in `body' after setting up the environment." `(let ((process-environment (copy-sequence process-environment)) ;; The following is so Awk script gets \n intact ;; But don't prevent decoding of the outside. diff --git a/lisp/mh-e/mh-acros.el b/lisp/mh-e/mh-acros.el index 0f15d3eb71..809771d6d4 100644 --- a/lisp/mh-e/mh-acros.el +++ b/lisp/mh-e/mh-acros.el @@ -160,8 +160,8 @@ Stronger than `save-excursion', weaker than `save-window-excursion'." ;;;###mh-autoload (defmacro mh-do-at-event-location (event &rest body) "Switch to the location of EVENT and execute BODY. -After BODY has been executed return to original window. The -modification flag of the buffer in the event window is +After BODY has been executed return to original window. +The modification flag of the buffer in the event window is preserved." (declare (debug t)) (let ((event-window (make-symbol "event-window")) @@ -206,7 +206,7 @@ preserved." "Iterate over region. VAR is bound to the message on the current line as we loop -starting from BEGIN till END. In each step BODY is executed. +starting from BEGIN till END. In each step BODY is executed. If VAR is nil then the loop is executed without any binding." (declare (debug (symbolp body))) @@ -230,7 +230,7 @@ If VAR is nil then the loop is executed without any binding." VAR is bound to each message in turn in a loop over RANGE, which can be a message number, a list of message numbers, a sequence, a region in a cons cell, or a MH range (something like last:20) in -a string. In each iteration, BODY is executed. +a string. In each iteration, BODY is executed. The parameter RANGE is usually created with `mh-interactive-range' in order to provide a uniform interface to diff --git a/lisp/mh-e/mh-alias.el b/lisp/mh-e/mh-alias.el index 2ff8801cd9..5573f22072 100644 --- a/lisp/mh-e/mh-alias.el +++ b/lisp/mh-e/mh-alias.el @@ -51,10 +51,10 @@ "/usr/lib/mh/MailAliases" "/usr/share/mailutils/mh/MailAliases" "/etc/passwd") "A list of system files which are a source of aliases. -If these files are modified, they are automatically reread. This list +If these files are modified, they are automatically reread. This list need include only system aliases and the passwd file, since personal alias files listed in your \"Aliasfile:\" MH profile component are -automatically included. You can update the alias list manually using +automatically included. You can update the alias list manually using \\[mh-alias-reload]." :type '(repeat file) :group 'mh-alias) @@ -170,9 +170,9 @@ Exclude all aliases already in `mh-alias-alist' from \"ali\"" Since aliases are updated frequently, MH-E reloads aliases automatically whenever an alias lookup occurs if an alias source has -changed. Sources include files listed in your \"Aliasfile:\" profile +changed. Sources include files listed in your \"Aliasfile:\" profile component and your password file if option `mh-alias-local-users' is -turned on. However, you can reload your aliases manually by calling +turned on. However, you can reload your aliases manually by calling this command directly. This function runs `mh-alias-reloaded-hook' after the aliases have @@ -224,8 +224,9 @@ been loaded." (defun mh-alias-ali (alias &optional user) "Return ali expansion for ALIAS. ALIAS must be a string for a single alias. -If USER is t, then assume ALIAS is an address and call ali -user. ali -returns the string unchanged if not defined. The same is done here." +If USER is t, then assume ALIAS is an address and call ali -user. +ali returns the string unchanged if not defined. The same is +done here." (condition-case err (save-excursion (let ((user-arg (if user "-user" "-nouser"))) @@ -378,8 +379,8 @@ NO-COMMA-SWAP is non-nil." (defun mh-alias-canonicalize-suggestion (string) "Process STRING to replace spaces by periods. -First all spaces and commas are replaced by periods. Then every run of -consecutive periods are replaced with a single period. Finally the +First all spaces and commas are replaced by periods. Then every run +of consecutive periods are replaced with a single period. Finally the string is converted to lower case." (with-temp-buffer (insert string) @@ -492,9 +493,9 @@ Prompt for alias file if not provided and there is more than one candidate. If the alias exists already, you will have the choice of -inserting the new alias before or after the old alias. In the +inserting the new alias before or after the old alias. In the former case, this alias will be used when sending mail to this -alias. In the latter case, the alias serves as an additional +alias. In the latter case, the alias serves as an additional folder name hint when filing messages." (if (not file) (setq file (mh-alias-insert-file alias))) @@ -544,10 +545,10 @@ folder name hint when filing messages." (defun mh-alias-add-alias (alias address) "Add ALIAS for ADDRESS in personal alias file. -This function prompts you for an alias and address. If the alias +This function prompts you for an alias and address. If the alias exists already, you will have the choice of inserting the new -alias before or after the old alias. In the former case, this -alias will be used when sending mail to this alias. In the latter +alias before or after the old alias. In the former case, this +alias will be used when sending mail to this alias. In the latter case, the alias serves as an additional folder name hint when filing messages." (interactive "P\nP") diff --git a/lisp/mouse.el b/lisp/mouse.el index e947e16d47..123ce2ca15 100644 --- a/lisp/mouse.el +++ b/lisp/mouse.el @@ -1592,7 +1592,7 @@ previous region was just saved to the kill ring). If this command is called a second consecutive time with the same CLICK position, kill the region (or delete it -if `mouse-drag-copy-region' is non-nil)" +if `mouse-drag-copy-region' is non-nil)." (interactive "e") (mouse-minibuffer-check click) (let* ((posn (event-start click)) diff --git a/lisp/net/browse-url.el b/lisp/net/browse-url.el index 87a8248854..ce899bdee5 100644 --- a/lisp/net/browse-url.el +++ b/lisp/net/browse-url.el @@ -877,7 +877,7 @@ The optional NEW-WINDOW argument is not used." (defun browse-url-default-macosx-browser (url &optional _new-window) "Invoke the macOS system's default Web browser. -The optional NEW-WINDOW argument is not used" +The optional NEW-WINDOW argument is not used." (interactive (browse-url-interactive-arg "URL: ")) (start-process (concat "open " url) nil "open" url)) diff --git a/lisp/net/eudc.el b/lisp/net/eudc.el index 3c9c01d0f9..586dd210ed 100644 --- a/lisp/net/eudc.el +++ b/lisp/net/eudc.el @@ -229,7 +229,7 @@ The current binding of VAR is changed only if SERVER is omitted." (defun eudc-set (var val) "Set the most local (server, protocol or default) binding of VAR to VAL. -The current binding of VAR is also set to VAL" +The current binding of VAR is also set to VAL." (cond ((not (eq 'unbound (eudc-variable-server-value var))) (eudc-server-set var val)) @@ -251,7 +251,7 @@ Return `unbound' if VAR has no EUDC default value." (defun eudc-variable-protocol-value (var &optional protocol) "Return the value of VAR local to PROTOCOL. Return `unbound' if VAR has no value local to PROTOCOL. -PROTOCOL defaults to `eudc-protocol'" +PROTOCOL defaults to `eudc-protocol'." (let* ((eudc-locals (get var 'eudc-locals)) protocol-locals) (if (not (and (boundp var) @@ -266,7 +266,7 @@ PROTOCOL defaults to `eudc-protocol'" (defun eudc-variable-server-value (var &optional server) "Return the value of VAR local to SERVER. Return `unbound' if VAR has no value local to SERVER. -SERVER defaults to `eudc-server'" +SERVER defaults to `eudc-server'." (let* ((eudc-locals (get var 'eudc-locals)) server-locals) (if (not (and (boundp var) @@ -282,7 +282,7 @@ SERVER defaults to `eudc-server'" "Set the value of VAR according to its locals. If the VAR has a server- or protocol-local value corresponding to the current `eudc-server' and `eudc-protocol' then it is set -accordingly. Otherwise it is set to its EUDC default binding" +accordingly. Otherwise it is set to its EUDC default binding." (let (val) (cond ((not (eq 'unbound (setq val (eudc-variable-server-value var)))) @@ -775,7 +775,7 @@ After querying the server for the given string, the expansion specified by If REPLACE is non-nil, then this expansion replaces the name in the buffer. `eudc-expansion-overwrites-query' being non-nil inverts the meaning of REPLACE. Multiple servers can be tried with the same query until one finds a match, -see `eudc-inline-expansion-servers'" +see `eudc-inline-expansion-servers'." (interactive) (cond ((eq eudc-inline-expansion-servers 'current-server) diff --git a/lisp/net/eudcb-bbdb.el b/lisp/net/eudcb-bbdb.el index f91d0af858..f9b3c47a4b 100644 --- a/lisp/net/eudcb-bbdb.el +++ b/lisp/net/eudcb-bbdb.el @@ -179,7 +179,7 @@ BBDB < 3 used `net'; BBDB >= 3 uses `mail'." (defun eudc-bbdb-format-record-as-result (record) "Format the BBDB RECORD as a EUDC query result record. -The record is filtered according to `eudc-bbdb-current-return-attributes'" +The record is filtered according to `eudc-bbdb-current-return-attributes'." (require 'bbdb) (let ((attrs (or eudc-bbdb-current-return-attributes '(firstname lastname aka company phones addresses net notes))) diff --git a/lisp/net/eudcb-ldap.el b/lisp/net/eudcb-ldap.el index 7514d1ad29..464c62da12 100644 --- a/lisp/net/eudcb-ldap.el +++ b/lisp/net/eudcb-ldap.el @@ -148,7 +148,7 @@ RETURN-ATTRS is a list of attributes to return, defaulting to (defun eudc-ldap-get-field-list (_dummy &optional objectclass) "Return a list of valid attribute names for the current server. OBJECTCLASS is the LDAP object class for which the valid -attribute names are returned. Default to `person'" +attribute names are returned. Default to `person'." (interactive) (or eudc-server (call-interactively 'eudc-set-server)) diff --git a/lisp/net/pop3.el b/lisp/net/pop3.el index 5f1cd94eb6..74a632a3a2 100644 --- a/lisp/net/pop3.el +++ b/lisp/net/pop3.el @@ -710,7 +710,7 @@ If NOW, use that time instead." (defun pop3-list (process &optional msg) "If MSG is nil, return an alist of (MESSAGE-ID . SIZE) pairs. -Otherwise, return the size of the message-id MSG" +Otherwise, return the size of the message-id MSG." (pop3-send-command process (if msg (format "LIST %d" msg) "LIST")) diff --git a/lisp/net/soap-client.el b/lisp/net/soap-client.el index 7ce7d79c74..3f9eb5cb89 100644 --- a/lisp/net/soap-client.el +++ b/lisp/net/soap-client.el @@ -334,7 +334,7 @@ element name." "Store ELEMENT in NS. Multiple elements with the same name can be stored in a namespace. When retrieving the element you can specify a -discriminant predicate to `soap-namespace-get'" +discriminant predicate to `soap-namespace-get'." (let ((name (soap-element-name element))) (push element (gethash name (soap-namespace-elements ns))))) @@ -1476,7 +1476,7 @@ This is a specialization of `soap-decode-type' for (defun soap-xs-parse-sequence (node) "Parse a sequence definition from XML NODE. -Returns a `soap-xs-complex-type'" +Returns a `soap-xs-complex-type'." (cl-assert (memq (soap-l2wk (xml-node-name node)) '(xsd:sequence xsd:choice xsd:all)) nil @@ -2814,7 +2814,7 @@ decode function to perform the actual decoding." (defun soap-parse-envelope (node operation wsdl) "Parse the SOAP envelope in NODE and return the response. OPERATION is the WSDL operation for which we expect the response, -WSDL is used to decode the NODE" +WSDL is used to decode the NODE." (soap-with-local-xmlns node (cl-assert (eq (soap-l2wk (xml-node-name node)) 'soap:Envelope) nil diff --git a/lisp/net/soap-inspect.el b/lisp/net/soap-inspect.el index 17b667504f..63c5ac53c2 100644 --- a/lisp/net/soap-inspect.el +++ b/lisp/net/soap-inspect.el @@ -355,7 +355,7 @@ ATTRIBUTE is a soap-xs-attribute-group." (defun soap-inspect-xs-complex-type (type) "Insert information about TYPE in the current buffer. -TYPE is a `soap-xs-complex-type'" +TYPE is a `soap-xs-complex-type'." (insert "Complex type: " (soap-element-fq-name type)) (insert "\nKind: ") (cl-case (soap-xs-complex-type-indicator type) diff --git a/lisp/nxml/rng-xsd.el b/lisp/nxml/rng-xsd.el index 582d08e149..5aa850f589 100644 --- a/lisp/nxml/rng-xsd.el +++ b/lisp/nxml/rng-xsd.el @@ -550,7 +550,7 @@ fractional part of the second." (< (car numbers1) (car numbers2)))) (defun rng-xsd-date-to-days (year month day) - "Return a unique day number where Jan 1 1 AD is day 1" + "Return a unique day number where Jan 1 1 AD is day 1." (if (> year 0) ; AD (+ (rng-xsd-days-in-years (- year 1)) (rng-xsd-day-number-in-year year month day)) diff --git a/lisp/org/ob-C.el b/lisp/org/ob-C.el index 36d79986dc..e08773bc97 100644 --- a/lisp/org/ob-C.el +++ b/lisp/org/ob-C.el @@ -299,12 +299,12 @@ its header arguments." (defun org-babel-prep-session:C (_session _params) "This function does nothing as C is a compiled language with no -support for sessions" +support for sessions." (error "C is a compiled language -- no support for sessions")) (defun org-babel-load-session:C (_session _body _params) "This function does nothing as C is a compiled language with no -support for sessions" +support for sessions." (error "C is a compiled language -- no support for sessions")) ;; helper functions diff --git a/lisp/org/ob-J.el b/lisp/org/ob-J.el index b9125df084..2d1715ac87 100644 --- a/lisp/org/ob-J.el +++ b/lisp/org/ob-J.el @@ -72,7 +72,7 @@ PROCESSED-PARAMS isn't used yet." (defun org-babel-execute:J (body params) "Execute a block of J code BODY. PARAMS are given by org-babel. -This function is called by `org-babel-execute-src-block'" +This function is called by `org-babel-execute-src-block'." (message "executing J source code block") (let* ((processed-params (org-babel-process-params params)) (sessionp (cdr (assq :session params))) diff --git a/lisp/org/ob-asymptote.el b/lisp/org/ob-asymptote.el index 667d3e106b..3fc0cebd60 100644 --- a/lisp/org/ob-asymptote.el +++ b/lisp/org/ob-asymptote.el @@ -77,7 +77,7 @@ This function is called by `org-babel-execute-src-block'." (defun org-babel-prep-session:asymptote (_session _params) "Return an error if the :session header argument is set. -Asymptote does not support sessions" +Asymptote does not support sessions." (error "Asymptote does not support sessions")) (defun org-babel-variable-assignments:asymptote (params) diff --git a/lisp/org/ob-awk.el b/lisp/org/ob-awk.el index 4c0dbbc67d..0d5f47d56f 100644 --- a/lisp/org/ob-awk.el +++ b/lisp/org/ob-awk.el @@ -48,8 +48,8 @@ body) (defun org-babel-execute:awk (body params) - "Execute a block of Awk code with org-babel. This function is -called by `org-babel-execute-src-block'" + "Execute a block of Awk code with org-babel. +This function is called by `org-babel-execute-src-block'." (message "executing Awk source code block") (let* ((result-params (cdr (assq :result-params params))) (cmd-line (cdr (assq :cmd-line params))) diff --git a/lisp/org/ob-core.el b/lisp/org/ob-core.el index b6c54a92ab..8e9e3edb1c 100644 --- a/lisp/org/ob-core.el +++ b/lisp/org/ob-core.el @@ -2975,7 +2975,7 @@ If NAME specifies a remote location, the remote portion of the name is removed, since in that case the process will be executing remotely. The file name is then processed by `expand-file-name'. Unless second argument NO-QUOTE-P is non-nil, the file name is -additionally processed by `shell-quote-argument'" +additionally processed by `shell-quote-argument'." (let ((f (org-babel-local-file-name (expand-file-name name)))) (if no-quote-p f (shell-quote-argument f)))) diff --git a/lisp/org/ob-ebnf.el b/lisp/org/ob-ebnf.el index 5ed9319e56..c229228520 100644 --- a/lisp/org/ob-ebnf.el +++ b/lisp/org/ob-ebnf.el @@ -49,8 +49,8 @@ ;; Use ebnf-eps-buffer to produce an encapsulated postscript file. ;; (defun org-babel-execute:ebnf (body params) - "Execute a block of Ebnf code with org-babel. This function is -called by `org-babel-execute-src-block'" + "Execute a block of Ebnf code with org-babel. +This function is called by `org-babel-execute-src-block'." (save-excursion (let* ((dest-file (cdr (assq :file params))) (dest-dir (file-name-directory dest-file)) diff --git a/lisp/org/ob-forth.el b/lisp/org/ob-forth.el index 88ed964fd7..de42042a5b 100644 --- a/lisp/org/ob-forth.el +++ b/lisp/org/ob-forth.el @@ -42,7 +42,7 @@ (defun org-babel-execute:forth (body params) "Execute a block of Forth code with org-babel. -This function is called by `org-babel-execute-src-block'" +This function is called by `org-babel-execute-src-block'." (if (string= "none" (cdr (assq :session params))) (error "Non-session evaluation not supported for Forth code blocks") (let ((all-results (org-babel-forth-session-execute body params))) diff --git a/lisp/org/ob-fortran.el b/lisp/org/ob-fortran.el index 579fb319c4..976c611bde 100644 --- a/lisp/org/ob-fortran.el +++ b/lisp/org/ob-fortran.el @@ -46,7 +46,7 @@ executable.") (defun org-babel-execute:fortran (body params) - "This function should only be called by `org-babel-execute:fortran'" + "This function should only be called by `org-babel-execute:fortran'." (let* ((tmp-src-file (org-babel-temp-file "fortran-src-" ".F90")) (tmp-bin-file (org-babel-temp-file "fortran-bin-" org-babel-exeext)) (cmdline (cdr (assq :cmdline params))) @@ -115,12 +115,12 @@ its header arguments." (defun org-babel-prep-session:fortran (_session _params) "This function does nothing as fortran is a compiled language with no -support for sessions" +support for sessions." (error "Fortran is a compiled languages -- no support for sessions")) (defun org-babel-load-session:fortran (_session _body _params) "This function does nothing as fortran is a compiled language with no -support for sessions" +support for sessions." (error "Fortran is a compiled languages -- no support for sessions")) ;; helper functions diff --git a/lisp/org/ob-groovy.el b/lisp/org/ob-groovy.el index fe3a072f17..a22e21df09 100644 --- a/lisp/org/ob-groovy.el +++ b/lisp/org/ob-groovy.el @@ -45,8 +45,8 @@ parameters may be used, like groovy -v" :type 'string) (defun org-babel-execute:groovy (body params) - "Execute a block of Groovy code with org-babel. This function is -called by `org-babel-execute-src-block'" + "Execute a block of Groovy code with org-babel. +This function is called by `org-babel-execute-src-block'." (message "executing Groovy source code block") (let* ((processed-params (org-babel-process-params params)) (session (org-babel-groovy-initiate-session (nth 0 processed-params))) diff --git a/lisp/org/ob-io.el b/lisp/org/ob-io.el index b0d5b51283..9817c64150 100644 --- a/lisp/org/ob-io.el +++ b/lisp/org/ob-io.el @@ -41,8 +41,8 @@ "Name of the command to use for executing Io code.") (defun org-babel-execute:io (body params) - "Execute a block of Io code with org-babel. This function is -called by `org-babel-execute-src-block'" + "Execute a block of Io code with org-babel. +This function is called by `org-babel-execute-src-block'." (message "executing Io source code block") (let* ((processed-params (org-babel-process-params params)) (session (org-babel-io-initiate-session (nth 0 processed-params))) diff --git a/lisp/org/ob-js.el b/lisp/org/ob-js.el index 233aa58161..dab3aa2fbd 100644 --- a/lisp/org/ob-js.el +++ b/lisp/org/ob-js.el @@ -60,7 +60,7 @@ (defun org-babel-execute:js (body params) "Execute a block of Javascript code with org-babel. -This function is called by `org-babel-execute-src-block'" +This function is called by `org-babel-execute-src-block'." (let* ((org-babel-js-cmd (or (cdr (assq :cmd params)) org-babel-js-cmd)) (result-type (cdr (assq :result-type params))) (full-body (org-babel-expand-body:generic diff --git a/lisp/org/ob-lilypond.el b/lisp/org/ob-lilypond.el index 25e5dbc7dc..c07ae78460 100644 --- a/lisp/org/ob-lilypond.el +++ b/lisp/org/ob-lilypond.el @@ -41,20 +41,20 @@ (defvar org-babel-default-header-args:lilypond '() "Default header arguments for lilypond code blocks. NOTE: The arguments are determined at lilypond compile time. -See (org-babel-lilypond-set-header-args)") +See `org-babel-lilypond-set-header-args'.") (defvar org-babel-lilypond-compile-post-tangle t "Following the org-babel-tangle (C-c C-v t) command, org-babel-lilypond-compile-post-tangle determines whether ob-lilypond should automatically attempt to compile the resultant tangled file. If the value is nil, no automated compilation takes place. -Default value is t") +Default value is t.") (defvar org-babel-lilypond-display-pdf-post-tangle t "Following a successful LilyPond compilation org-babel-lilypond-display-pdf-post-tangle determines whether to automate the drawing / redrawing of the resultant pdf. If the value is nil, -the pdf is not automatically redrawn. Default value is t") +the pdf is not automatically redrawn. Default value is t.") (defvar org-babel-lilypond-play-midi-post-tangle t "Following a successful LilyPond compilation @@ -150,7 +150,7 @@ Depending on whether we are in arrange mode either: (defun org-babel-lilypond-tangle () "ob-lilypond specific tangle, attempts to invoke =ly-execute-tangled-ly= if tangle is successful. Also passes -specific arguments to =org-babel-tangle=" +specific arguments to =org-babel-tangle=." (interactive) (if (org-babel-tangle nil "yes" "lilypond") (org-babel-lilypond-execute-tangled-ly) nil)) @@ -187,7 +187,7 @@ specific arguments to =org-babel-tangle=" (defun org-babel-lilypond-execute-tangled-ly () "Compile result of block tangle with lilypond. -If error in compilation, attempt to mark the error in lilypond org file" +If error in compilation, attempt to mark the error in lilypond org file." (when org-babel-lilypond-compile-post-tangle (let ((org-babel-lilypond-tangled-file (org-babel-lilypond-switch-extension (buffer-file-name) ".lilypond")) @@ -210,8 +210,8 @@ If error in compilation, attempt to mark the error in lilypond org file" (org-babel-lilypond-attempt-to-play-midi org-babel-lilypond-temp-file))))) (defun org-babel-lilypond-compile-lilyfile (file-name &optional test) - "Compile lilypond file and check for compile errors -FILE-NAME is full path to lilypond (.ly) file" + "Compile lilypond file and check for compile errors. +FILE-NAME is full path to lilypond (.ly) file." (message "Compiling LilyPond...") (let ((arg-1 org-babel-lilypond-ly-command) ;program (arg-2 nil) ;infile @@ -237,7 +237,7 @@ This is performed by parsing the *lilypond* buffer containing the output message from the compilation. FILE-NAME is full path to lilypond file. If TEST is t just return nil if no error found, and pass -nil as file-name since it is unused in this context" +nil as file-name since it is unused in this context." (let ((is-error (search-forward "error:" nil t))) (if test is-error @@ -246,7 +246,7 @@ nil as file-name since it is unused in this context" (defun org-babel-lilypond-process-compile-error (file-name) "Process the compilation error that has occurred. -FILE-NAME is full path to lilypond file" +FILE-NAME is full path to lilypond file." (let ((line-num (org-babel-lilypond-parse-line-num))) (let ((error-lines (org-babel-lilypond-parse-error-line file-name line-num))) (org-babel-lilypond-mark-error-line file-name error-lines) @@ -255,7 +255,7 @@ FILE-NAME is full path to lilypond file" (defun org-babel-lilypond-mark-error-line (file-name line) "Mark the erroneous lines in the lilypond org buffer. FILE-NAME is full path to lilypond file. -LINE is the erroneous line" +LINE is the erroneous line." (switch-to-buffer-other-window (concat (file-name-nondirectory (org-babel-lilypond-switch-extension file-name ".org")))) @@ -286,9 +286,9 @@ LINE is the erroneous line" (and (numberp num) num))))) (defun org-babel-lilypond-parse-error-line (file-name lineNo) - "Extract the erroneous line from the tangled .ly file + "Extract the erroneous line from the tangled .ly file. FILE-NAME is full path to lilypond file. -LINENO is the number of the erroneous line" +LINENO is the number of the erroneous line." (with-temp-buffer (insert-file-contents (org-babel-lilypond-switch-extension file-name ".ly") nil nil nil t) @@ -300,9 +300,9 @@ LINENO is the number of the erroneous line" nil))) (defun org-babel-lilypond-attempt-to-open-pdf (file-name &optional test) - "Attempt to display the generated pdf file -FILE-NAME is full path to lilypond file -If TEST is non-nil, the shell command is returned and is not run" + "Attempt to display the generated pdf file. +FILE-NAME is full path to lilypond file. +If TEST is non-nil, the shell command is returned and is not run." (when org-babel-lilypond-display-pdf-post-tangle (let ((pdf-file (org-babel-lilypond-switch-extension file-name ".pdf"))) (if (file-exists-p pdf-file) @@ -318,9 +318,9 @@ If TEST is non-nil, the shell command is returned and is not run" (message "No pdf file generated so can't display!"))))) (defun org-babel-lilypond-attempt-to-play-midi (file-name &optional test) - "Attempt to play the generated MIDI file -FILE-NAME is full path to lilypond file -If TEST is non-nil, the shell command is returned and is not run" + "Attempt to play the generated MIDI file. +FILE-NAME is full path to lilypond file. +If TEST is non-nil, the shell command is returned and is not run." (when org-babel-lilypond-play-midi-post-tangle (let ((midi-file (org-babel-lilypond-switch-extension file-name ".midi"))) (if (file-exists-p midi-file) @@ -383,14 +383,13 @@ If TEST is non-nil, the shell command is returned and is not run" (if org-babel-lilypond-arrange-mode "ENABLED." "DISABLED.")))) (defun org-babel-lilypond-switch-extension (file-name ext) - "Utility command to swap current FILE-NAME extension with EXT" + "Utility command to swap current FILE-NAME extension with EXT." (concat (file-name-sans-extension file-name) ext)) (defun org-babel-lilypond-get-header-args (mode) - "Default arguments to use when evaluating a lilypond -source block. These depend upon whether we are in arrange -mode i.e. ARRANGE-MODE is t" + "Default arguments to use when evaluating a lilypond source block. +These depend upon whether we are in Arrange mode i.e. MODE is t." (cond (mode '((:tangle . "yes") (:noweb . "yes") @@ -403,7 +402,7 @@ mode i.e. ARRANGE-MODE is t" (defun org-babel-lilypond-set-header-args (mode) "Set org-babel-default-header-args:lilypond -dependent on ORG-BABEL-LILYPOND-ARRANGE-MODE" +dependent on ORG-BABEL-LILYPOND-ARRANGE-MODE." (setq org-babel-default-header-args:lilypond (org-babel-lilypond-get-header-args mode))) diff --git a/lisp/org/ob-lua.el b/lisp/org/ob-lua.el index 6f779413eb..9b152f29f4 100644 --- a/lisp/org/ob-lua.el +++ b/lisp/org/ob-lua.el @@ -101,7 +101,7 @@ This function is called by `org-babel-execute-src-block'." (defun org-babel-prep-session:lua (session params) "Prepare SESSION according to the header arguments in PARAMS. -VARS contains resolved variable references" +VARS contains resolved variable references." (let* ((session (org-babel-lua-initiate-session session)) (var-lines (org-babel-variable-assignments:lua params))) diff --git a/lisp/org/ob-picolisp.el b/lisp/org/ob-picolisp.el index c0f012572e..4f70252986 100644 --- a/lisp/org/ob-picolisp.el +++ b/lisp/org/ob-picolisp.el @@ -94,8 +94,8 @@ body))) (defun org-babel-execute:picolisp (body params) - "Execute a block of Picolisp code with org-babel. This function is - called by `org-babel-execute-src-block'" + "Execute a block of Picolisp code with org-babel. +This function is called by `org-babel-execute-src-block'." (message "executing Picolisp source code block") (let* ( ;; Name of the session or "none". diff --git a/lisp/org/ob-processing.el b/lisp/org/ob-processing.el index 97ab88cbef..7bb9fa1bc9 100644 --- a/lisp/org/ob-processing.el +++ b/lisp/org/ob-processing.el @@ -135,7 +135,7 @@ This function is called by `org-babel-execute-src-block'." (defun org-babel-prep-session:processing (_session _params) "Return an error if the :session header argument is set. -Processing does not support sessions" +Processing does not support sessions." (error "Processing does not support sessions")) (defun org-babel-variable-assignments:processing (params) diff --git a/lisp/org/ob-python.el b/lisp/org/ob-python.el index 546e35a6a9..b10320ee53 100644 --- a/lisp/org/ob-python.el +++ b/lisp/org/ob-python.el @@ -98,7 +98,7 @@ This function is called by `org-babel-execute-src-block'." (defun org-babel-prep-session:python (session params) "Prepare SESSION according to the header arguments in PARAMS. -VARS contains resolved variable references" +VARS contains resolved variable references." (let* ((session (org-babel-python-initiate-session session)) (var-lines (org-babel-variable-assignments:python params))) diff --git a/lisp/org/ob-ruby.el b/lisp/org/ob-ruby.el index e0e1765f88..309bd15a00 100644 --- a/lisp/org/ob-ruby.el +++ b/lisp/org/ob-ruby.el @@ -215,7 +215,7 @@ return the value of the last statement in BODY, as elisp." (let ((eoe-string (format "puts \"%s\"" org-babel-ruby-eoe-indicator))) ;; Force the session to be ready before the actual session ;; code is run. There is some problem in comint that will - ;; sometimes show the prompt after the the input has already + ;; sometimes show the prompt after the input has already ;; been inserted and that throws off the extraction of the ;; result for Babel. (org-babel-comint-with-output diff --git a/lisp/org/ob-scheme.el b/lisp/org/ob-scheme.el index 798cf4eb0c..af5c7f26d6 100644 --- a/lisp/org/ob-scheme.el +++ b/lisp/org/ob-scheme.el @@ -132,7 +132,7 @@ org-babel-scheme-execute-with-geiser will use a temporary session." (name))) (defmacro org-babel-scheme-capture-current-message (&rest body) - "Capture current message in both interactive and noninteractive mode" + "Capture current message in both interactive and noninteractive mode." `(if noninteractive (let ((original-message (symbol-function 'message)) (current-message nil)) @@ -148,10 +148,11 @@ org-babel-scheme-execute-with-geiser will use a temporary session." (current-message)))) (defun org-babel-scheme-execute-with-geiser (code output impl repl) - "Execute code in specified REPL. If the REPL doesn't exist, create it -using the given scheme implementation. + "Execute code in specified REPL. +If the REPL doesn't exist, create it using the given scheme +implementation. -Returns the output of executing the code if the output parameter +Returns the output of executing the code if the OUTPUT parameter is true; otherwise returns the last value." (let ((result nil)) (with-temp-buffer @@ -199,7 +200,7 @@ Emacs-lisp table, otherwise return the results as a string." (defun org-babel-execute:scheme (body params) "Execute a block of Scheme code with org-babel. -This function is called by `org-babel-execute-src-block'" +This function is called by `org-babel-execute-src-block'." (let* ((source-buffer (current-buffer)) (source-buffer-name (replace-regexp-in-string ;; zap surrounding * "^ ?\\*\\([^*]+\\)\\*" "\\1" diff --git a/lisp/org/ob-shen.el b/lisp/org/ob-shen.el index af3bd2ba38..f2daa67606 100644 --- a/lisp/org/ob-shen.el +++ b/lisp/org/ob-shen.el @@ -61,7 +61,7 @@ (defun org-babel-execute:shen (body params) "Execute a block of Shen code with org-babel. -This function is called by `org-babel-execute-src-block'" +This function is called by `org-babel-execute-src-block'." (require 'inf-shen) (let* ((result-params (cdr (assq :result-params params))) (full-body (org-babel-expand-body:shen body params))) diff --git a/lisp/org/org-agenda.el b/lisp/org/org-agenda.el index e50ec3cf08..66c3d965e0 100644 --- a/lisp/org/org-agenda.el +++ b/lisp/org/org-agenda.el @@ -267,7 +267,7 @@ you can \"misuse\" it to also add other text to the header." "List of types searched for when creating the daily/weekly agenda. This variable is a list of symbols that controls the types of items that appear in the daily/weekly agenda. Allowed symbols in this -list are are +list are :timestamp List items containing a date stamp or date range matching the selected date. This includes sexp entries in angular @@ -1225,9 +1225,9 @@ These days get the special face `org-agenda-date-weekend' in the agenda." (defcustom org-agenda-move-date-from-past-immediately-to-today t "Non-nil means jump to today when moving a past date forward in time. -When using S-right in the agenda to move a a date forward, and the date +When using S-right in the agenda to move a date forward, and the date stamp currently points to the past, the first key press will move it -to today. WHen nil, just move one day forward even if the date stays +to today. When nil, just move one day forward even if the date stays in the past." :group 'org-agenda-daily/weekly :version "24.1" @@ -1498,7 +1498,7 @@ The third item is a string which will be placed right after the times that have a grid line. The fourth item is a string placed after the grid times. This -will align with agenda items" +will align with agenda items." :group 'org-agenda-time-grid :type '(list @@ -1542,18 +1542,18 @@ This is a list of symbols which will be used in sequence to determine if an entry should be listed before another entry. The following symbols are recognized: -time-up Put entries with time-of-day indications first, early first -time-down Put entries with time-of-day indications first, late first -timestamp-up Sort by any timestamp, early first -timestamp-down Sort by any timestamp, late first -scheduled-up Sort by scheduled timestamp, early first -scheduled-down Sort by scheduled timestamp, late first -deadline-up Sort by deadline timestamp, early first -deadline-down Sort by deadline timestamp, late first -ts-up Sort by active timestamp, early first -ts-down Sort by active timestamp, late first -tsia-up Sort by inactive timestamp, early first -tsia-down Sort by inactive timestamp, late first +time-up Put entries with time-of-day indications first, early first. +time-down Put entries with time-of-day indications first, late first. +timestamp-up Sort by any timestamp, early first. +timestamp-down Sort by any timestamp, late first. +scheduled-up Sort by scheduled timestamp, early first. +scheduled-down Sort by scheduled timestamp, late first. +deadline-up Sort by deadline timestamp, early first. +deadline-down Sort by deadline timestamp, late first. +ts-up Sort by active timestamp, early first. +ts-down Sort by active timestamp, late first. +tsia-up Sort by inactive timestamp, early first. +tsia-down Sort by inactive timestamp, late first. category-keep Keep the default order of categories, corresponding to the sequence in `org-agenda-files'. category-up Sort alphabetically by category, A-Z. @@ -1568,10 +1568,10 @@ effort-up Sort numerically by estimated effort, high effort last. effort-down Sort numerically by estimated effort, high effort first. user-defined-up Sort according to `org-agenda-cmp-user-defined', high last. user-defined-down Sort according to `org-agenda-cmp-user-defined', high first. -habit-up Put entries that are habits first -habit-down Put entries that are habits last -alpha-up Sort headlines alphabetically -alpha-down Sort headlines alphabetically, reversed +habit-up Put entries that are habits first. +habit-down Put entries that are habits last. +alpha-up Sort headlines alphabetically. +alpha-down Sort headlines alphabetically, reversed. The different possibilities will be tried in sequence, and testing stops if one comparison returns a \"not-equal\". For example, the default @@ -7365,8 +7365,7 @@ With a prefix argument, do so in all agenda buffers." "Filter lines in the agenda buffer that have a specific category. The category is that of the current line. Without prefix argument, keep only the lines of that category. -With a prefix argument, exclude the lines of that category. -" +With a prefix argument, exclude the lines of that category." (interactive "P") (if (and org-agenda-filtered-by-category org-agenda-category-filter) @@ -7882,7 +7881,7 @@ Negative selection means regexp must not match for selection of an entry." (defun org-agenda-forward-block (&optional backward) "Move forward by one agenda block. -When optional argument BACKWARD is set, go backward" +When optional argument BACKWARD is set, go backward." (interactive) (cond ((not (derived-mode-p 'org-agenda-mode)) (user-error diff --git a/lisp/org/org-colview.el b/lisp/org/org-colview.el index 799cc608bf..51a8eff33d 100644 --- a/lisp/org/org-colview.el +++ b/lisp/org/org-colview.el @@ -307,7 +307,7 @@ integers greater than 0." (error "Unknown %S operator" operator))))) (defun org-columns--overlay-text (value fmt width property original) - "Return text " + "Return text." (format fmt (let ((v (org-columns-add-ellipses value width))) (pcase property diff --git a/lisp/org/org-faces.el b/lisp/org/org-faces.el index 7ab5736e87..ffd1c4494f 100644 --- a/lisp/org/org-faces.el +++ b/lisp/org/org-faces.el @@ -409,7 +409,7 @@ See also `org-fontify-quote-and-verse-blocks'." :group 'org-faces) (defface org-verbatim '((t (:inherit shadow))) - "Face for fixed-with text like code snippets" + "Face for fixed-with text like code snippets." :group 'org-faces :version "22.1") @@ -602,8 +602,8 @@ If it is less than 8, the level-1 face gets re-used 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-indent.el b/lisp/org/org-indent.el index 97cf878656..4904d8177e 100644 --- a/lisp/org/org-indent.el +++ b/lisp/org/org-indent.el @@ -298,7 +298,7 @@ LEVEL is the current level of heading. INDENTATION is the expected indentation when wrapping line. When optional argument HEADING is non-nil, assume line is at -a heading. Moreover, if is is `inlinetask', the first star will +a heading. Moreover, if it is `inlinetask', the first star will have `org-warning' face." (let* ((line (aref (pcase heading (`nil org-indent--text-line-prefixes) diff --git a/lisp/org/org-macs.el b/lisp/org/org-macs.el index 3c76824433..bb96a06165 100644 --- a/lisp/org/org-macs.el +++ b/lisp/org/org-macs.el @@ -340,7 +340,7 @@ point nowhere." (defvar org-inlinetask-min-level) ; defined in org-inlinetask.el (defun org-get-limited-outline-regexp () "Return outline-regexp with limited number of levels. -The number of levels is controlled by `org-inlinetask-min-level'" +The number of levels is controlled by `org-inlinetask-min-level'." (cond ((not (derived-mode-p 'org-mode)) outline-regexp) ((not (featurep 'org-inlinetask)) diff --git a/lisp/org/org-mobile.el b/lisp/org/org-mobile.el index a1552606eb..dba6ca22f9 100644 --- a/lisp/org/org-mobile.el +++ b/lisp/org/org-mobile.el @@ -55,7 +55,7 @@ org-agenda-files the variable `org-agenda-files'. org-agenda-text-search-extra-files Include the files given in the variable - `org-agenda-text-search-extra-files'" + `org-agenda-text-search-extra-files'." :group 'org-mobile :type '(list :greedy t (option (const :tag "org-agenda-files" org-agenda-files)) diff --git a/lisp/org/org.el b/lisp/org/org.el index 1bb46e49c7..ca223d6ee2 100644 --- a/lisp/org/org.el +++ b/lisp/org/org.el @@ -2710,7 +2710,7 @@ selection scheme. When nil, fast selection is never used. When the symbol `prefix', it will be used when `org-todo' is called -with a prefix argument, i.e. `\\[universal-argument] \\[org-todo]' \ +with a prefix argument, i.e. `\\[universal-argument] \\[org-todo]' \ in an Org buffer, and `\\[universal-argument] t' in an agenda buffer. @@ -3355,7 +3355,7 @@ When nil, only the minibuffer will be available." (defcustom org-extend-today-until 0 "The hour when your day really ends. Must be an integer. This has influence for the following applications: -- When switching the agenda to \"today\". It it is still earlier than +- When switching the agenda to \"today\". If it is still earlier than the time given here, the day recognized as TODAY is actually yesterday. - When a date is read from the user and it is still before the time given here, the current date and time will be assumed to be yesterday, 23:59. @@ -3676,7 +3676,7 @@ and the properties ending in \"_ALL\" when they are used as descriptor for valid values of a property. Note for programmers: -When querying an entry with `org-entry-get', you can control if inheritance +When querying an entry with `org-entry-get', you can control if inheritance should be used. By default, `org-entry-get' looks only at the local properties. You can request inheritance by setting the inherit argument to t (to force inheritance) or to `selective' (to respect the setting @@ -9562,7 +9562,7 @@ sub-tree if optional argument INHERIT is non-nil." 'org-stats stats))))))) (defun org-refresh-effort-properties () - "Refresh effort properties" + "Refresh effort properties." (org-refresh-properties org-effort-property '((effort . identity) @@ -10492,7 +10492,7 @@ This is saved in case the need arises to restore it.") This command can be called in any mode to follow an external link or a time-stamp that has Org mode syntax. Its behavior is undefined when called on internal links (e.g., fuzzy links). -Raise an error when there is nothing to follow. " +Raise an error when there is nothing to follow." (interactive) (cond ((org-in-regexp org-any-link-re) (org-open-link-from-string (match-string-no-properties 0))) @@ -12661,7 +12661,7 @@ not relevant for the behavior, but it makes things more visible. Note that toggling the tag with tags commands will not change the property and therefore not influence behavior! -This can be t, meaning the tag ORDERED should be used, It can also be a +This can be t, meaning the tag ORDERED should be used. It can also be a string to select a different tag for this task." :group 'org-todo :type '(choice @@ -20489,7 +20489,7 @@ depending on context. See the individual commands for more information." Depending on context, this does one of the following: - switch a timestamp at point one day into the future -- on a headline, switch to the next TODO keyword. +- on a headline, switch to the next TODO keyword - on an item, switch entire list to the next bullet type - on a property line, switch to the next allowed value - on a clocktable definition line, move time block into the future" diff --git a/lisp/org/ox-html.el b/lisp/org/ox-html.el index 1f98fcdd5c..8445f236ba 100644 --- a/lisp/org/ox-html.el +++ b/lisp/org/ox-html.el @@ -1138,7 +1138,7 @@ checkboxes. The other two use the `off' checkbox for `trans'.") (defcustom org-html-checkbox-type 'ascii "The type of checkboxes to use for HTML export. -See `org-html-checkbox-types' for for the values used for each +See `org-html-checkbox-types' for the values used for each option." :group 'org-export-html :version "24.4" diff --git a/lisp/org/ox-latex.el b/lisp/org/ox-latex.el index b029f828e4..e617317a06 100644 --- a/lisp/org/ox-latex.el +++ b/lisp/org/ox-latex.el @@ -3319,7 +3319,7 @@ property." (let ((attr (org-export-read-attribute :attr_latex table))) (when (plist-get attr :rmlines) ;; When the "rmlines" attribute is provided, remove all hlines - ;; but the the one separating heading from the table body. + ;; but the one separating heading from the table body. (let ((n 0) (pos 0)) (while (and (< (length output) pos) (setq pos (string-match "^\\\\hline\n?" output pos))) diff --git a/lisp/org/ox-man.el b/lisp/org/ox-man.el index 816cc3662e..c0b0f7d223 100644 --- a/lisp/org/ox-man.el +++ b/lisp/org/ox-man.el @@ -159,7 +159,7 @@ When nil, no transformation is made." ;; Src blocks (defcustom org-man-source-highlight nil - "Use GNU source highlight to embellish source blocks " + "Use GNU source highlight to embellish source blocks." :group 'org-export-man :version "24.4" :package-version '(Org . "8.0") @@ -1042,7 +1042,7 @@ holding contextual information." (defun org-man-verse-block (_verse-block contents _info) "Transcode a VERSE-BLOCK element from Org to Man. -CONTENTS is verse block contents. INFO is a plist holding +CONTENTS is verse block contents. INFO is a plist holding contextual information." (format ".RS\n.ft I\n%s\n.ft\n.RE" contents)) diff --git a/lisp/org/ox-publish.el b/lisp/org/ox-publish.el index 237b2ff816..39547382b2 100644 --- a/lisp/org/ox-publish.el +++ b/lisp/org/ox-publish.el @@ -907,7 +907,7 @@ PROJECT is the current project." (defun org-publish-sitemap-default (title list) "Default site map, as a string. -TITLE is the the title of the site map. LIST is an internal +TITLE is the title of the site map. LIST is an internal representation for the files to include, as returned by `org-list-to-lisp'. PROJECT is the current project." (concat "#+TITLE: " title "\n\n" diff --git a/lisp/outline.el b/lisp/outline.el index 74df77b8be..be9f3172b7 100644 --- a/lisp/outline.el +++ b/lisp/outline.el @@ -537,10 +537,10 @@ nil for WHICH, or do not pass any argument)." If there are no such entries, return nil. ALIST defaults to `outline-heading-alist'. Similar to (car (rassoc LEVEL ALIST)). -If there are several different entries with same new level, choose -the one with the smallest distance to the association of HEAD in the alist. +If there are several different entries with same new level, choose the +one with the smallest distance to the association of HEAD in the alist. This makes it possible for promotion to work in modes with several -independent sets of headings (numbered, unnumbered, appendix...)" +independent sets of headings (numbered, unnumbered, appendix...)." (unless alist (setq alist outline-heading-alist)) (let ((l (rassoc level alist)) ll h hl l2 l2l) diff --git a/lisp/progmodes/cc-engine.el b/lisp/progmodes/cc-engine.el index 29ebe2eea1..4916b1dabb 100644 --- a/lisp/progmodes/cc-engine.el +++ b/lisp/progmodes/cc-engine.el @@ -7554,7 +7554,7 @@ comment at the start of cc-engine.el for more info." (defun c-maybe-re-mark-raw-string () ;; When this function is called, point is immediately after a " which opens - ;; a string. If this " is the characteristic " of of a raw string + ;; a string. If this " is the characteristic " of a raw string ;; opener, apply the pertinent `syntax-table' text properties to the ;; entire raw string (when properly terminated) or just the delimiter ;; (otherwise). In either of these cases, return t, otherwise return nil. diff --git a/lisp/progmodes/dcl-mode.el b/lisp/progmodes/dcl-mode.el index 864074fe19..85923ce9fe 100644 --- a/lisp/progmodes/dcl-mode.el +++ b/lisp/progmodes/dcl-mode.el @@ -784,7 +784,7 @@ by the numbers in order 1-2-3-1-... : (dcl-back-to-indentation-1 (point)) (dcl-back-to-indentation-1))) (defun dcl-back-to-indentation-1 (&optional limit) - "Helper function for dcl-back-to-indentation" + "Helper function for `dcl-back-to-indentation'." ;; "Indentation points" that we will travel to ;; $ l: ! comment @@ -1074,8 +1074,7 @@ dcl-calc-command-indent-function is nil or returns nil set cur-indent to cur-indent+extra-indent. See also documentation for dcl-calc-command-indent-function. -The indent-type classification could probably be expanded upon. -" +The indent-type classification could probably be expanded upon." () (save-excursion (beginning-of-line) @@ -1458,7 +1457,7 @@ regexps in `dcl-electric-reindent-regexps'." ;;;------------------------------------------------------------------------- (defun dcl-indent-to (col &optional minimum) - "Like indent-to, but only indents if indentation would change" + "Like `indent-to', but only indents if indentation would change." (interactive) (let (cur-indent collapsed indent) (save-excursion diff --git a/lisp/progmodes/flymake.el b/lisp/progmodes/flymake.el index 6d47c8bb17..6891e19fd1 100644 --- a/lisp/progmodes/flymake.el +++ b/lisp/progmodes/flymake.el @@ -317,7 +317,7 @@ TYPE is a key to symbol and TEXT is a description of the problem detected in this region. DATA is any object that the caller wishes to attach to the created diagnostic for later retrieval. -OVERLAY-PROPERTIES is an an alist of properties attached to the +OVERLAY-PROPERTIES is an alist of properties attached to the created diagnostic, overriding the default properties and any properties of `flymake-overlay-control' of the diagnostic's type." @@ -358,7 +358,7 @@ diagnostics at BEG." (cl-defun flymake--overlays (&key beg end filter compare key) "Get flymake-related overlays. If BEG is non-nil and END is nil, consider only `overlays-at' -BEG. Otherwise consider `overlays-in' the region comprised by BEG +BEG. Otherwise consider `overlays-in' the region comprised by BEG and END, defaulting to the whole buffer. Remove all that do not verify FILTER, a function, and sort them by COMPARE (using KEY)." (save-restriction @@ -498,7 +498,7 @@ this buffer. To reset the list of disabled backends, turn `flymake-start' with a prefix argument. If the function returns, Flymake considers the backend to be -\"running\". If it has not done so already, the backend is +\"running\". If it has not done so already, the backend is expected to call the function REPORT-FN with a single argument REPORT-ACTION also followed by an optional list of keyword-value pairs in the form (:REPORT-KEY VALUE :REPORT-KEY2 VALUE2...). @@ -513,8 +513,8 @@ Currently accepted values for REPORT-ACTION are: A backend may call REPORT-FN repeatedly in this manner, but only until Flymake considers that the most recently requested buffer check is now obsolete because, say, buffer contents have - changed in the meantime. The backend is only given notice of - this via a renewed call to the backend function. Thus, to + changed in the meantime. The backend is only given notice of + this via a renewed call to the backend function. Thus, to prevent making obsolete reports and wasting resources, backend functions should first cancel any ongoing processing from previous calls. @@ -545,7 +545,7 @@ Currently accepted REPORT-KEY arguments are: (defvar flymake-diagnostic-types-alist '() "") (make-obsolete-variable 'flymake-diagnostic-types-alist - "Set properties on the diagnostic symbols instead. See Info + "Set properties on the diagnostic symbols instead. See Info Node `(Flymake)Flymake error types'" "27.1") @@ -666,12 +666,12 @@ associated `flymake-category' return DEFAULT." (defvar-local flymake--backend-state nil "Buffer-local hash table of a Flymake backend's state. The keys to this hash table are functions as found in -`flymake-diagnostic-functions'. The values are structures +`flymake-diagnostic-functions'. The values are structures of the type `flymake--backend-state', with these slots: `running', a symbol to keep track of a backend's replies via its -REPORT-FN argument. A backend is running if this key is -present. If nil, Flymake isn't expecting any replies from the +REPORT-FN argument. A backend is running if this key is +present. If nil, Flymake isn't expecting any replies from the backend. `diags', a (possibly empty) list of recent diagnostic objects @@ -700,7 +700,7 @@ backend is operating normally.") ,@body))) (defun flymake-is-running () - "Tell if Flymake has running backends in this buffer" + "Tell if Flymake has running backends in this buffer." (flymake-running-backends)) ;; FIXME: clone of `isearch-intesects-p'! Make this an util. @@ -804,7 +804,7 @@ different runs of the same backend." (defun flymake--collect (fn &optional message-prefix) "Collect Flymake backends matching FN. -If MESSAGE-PREFIX, echo a message using that prefix" +If MESSAGE-PREFIX, echo a message using that prefix." (unless flymake--backend-state (user-error "Flymake is not initialized")) (let (retval) @@ -979,7 +979,7 @@ buffer happens via the special hook Some backends may take longer than others to respond or complete, and some may decide to disable themselves if they are not -suitable for the current buffer. The commands +suitable for the current buffer. The commands `flymake-running-backends', `flymake-disabled-backends' and `flymake-reporting-backends' summarize the situation, as does the special *Flymake log* buffer." :group 'flymake :lighter diff --git a/lisp/progmodes/gdb-mi.el b/lisp/progmodes/gdb-mi.el index 48c7dde9f5..1c8fad3069 100644 --- a/lisp/progmodes/gdb-mi.el +++ b/lisp/progmodes/gdb-mi.el @@ -154,7 +154,7 @@ May be manually changed by user with `gdb-select-frame'.") "Associative list of threads provided by \"-thread-info\" MI command. Keys are thread numbers (in strings) and values are structures as -returned from -thread-info by `gdb-json-partial-output'. Updated in +returned from -thread-info by `gdb-json-partial-output'. Updated in `gdb-thread-list-handler-custom'.") (defvar gdb-running-threads-count nil @@ -378,18 +378,18 @@ Must be a list of pairs with cars being buffers and cdr's being valid signal handlers.") (defgroup gdb nil - "GDB graphical interface" + "GDB graphical interface." :group 'tools :link '(info-link "(emacs)GDB Graphical Interface") :version "23.2") (defgroup gdb-non-stop nil - "GDB non-stop debugging settings" + "GDB non-stop debugging settings." :group 'gdb :version "23.2") (defgroup gdb-buffers nil - "GDB buffers" + "GDB buffers." :group 'gdb :version "23.2") @@ -657,7 +657,7 @@ When `gdb-non-stop' is nil, return COMMAND unchanged." "`gud-call' wrapper which adds --thread/--all options between CMD1 and CMD2. NOALL is the same as in `gdb-gud-context-command'. -NOARG must be t when this macro is used outside `gud-def'" +NOARG must be t when this macro is used outside `gud-def'." `(gud-call (concat (gdb-gud-context-command ,cmd1 ,noall) " " ,cmd2) ,(when (not noarg) 'arg))) @@ -2681,7 +2681,7 @@ in MI messages, e.g.: [key=.., key=..]. -stack-list-frames and responses. If FIX-LIST is non-nil, \"FIX-LIST={..}\" is replaced with -\"FIX-LIST=[..]\" prior to parsing. This is used to fix broken +\"FIX-LIST=[..]\" prior to parsing. This is used to fix broken -break-info output when it contains breakpoint script field incompatible with GDB/MI output syntax. diff --git a/lisp/progmodes/grep.el b/lisp/progmodes/grep.el index 306ae8fd50..fec87bbd1c 100644 --- a/lisp/progmodes/grep.el +++ b/lisp/progmodes/grep.el @@ -255,7 +255,7 @@ to limit saving to files located under `my-grep-root'." (defcustom grep-error-screen-columns nil "If non-nil, column numbers in grep hits are screen columns. -See `compilation-error-screen-columns'" +See `compilation-error-screen-columns'." :type '(choice (const :tag "Default" nil) integer) :version "22.1" diff --git a/lisp/progmodes/gud.el b/lisp/progmodes/gud.el index 235546ef2e..396141b388 100644 --- a/lisp/progmodes/gud.el +++ b/lisp/progmodes/gud.el @@ -3069,7 +3069,7 @@ the character after the end of the expr." "Returns the previous expr, point is set to beginning of that expr. The expr is represented as a cons cell, where the car specifies the point in the current buffer that marks the beginning of the expr and the cdr specifies -the character after the end of the expr" +the character after the end of the expr." (let ((begin) (end)) (gud-backward-sexp) (setq begin (point)) diff --git a/lisp/progmodes/perl-mode.el b/lisp/progmodes/perl-mode.el index 7cbd30a0d1..55ea3417ff 100644 --- a/lisp/progmodes/perl-mode.el +++ b/lisp/progmodes/perl-mode.el @@ -500,7 +500,7 @@ "Indentation of Perl statements with respect to containing block." :type 'integer) -;; Is is not unusual to put both things like perl-indent-level and +;; It is not unusual to put both things like perl-indent-level and ;; cperl-indent-level in the local variable section of a file. If only ;; one of perl-mode and cperl-mode is in use, a warning will be issued ;; about the variable. Autoload these here, so that no warning is diff --git a/lisp/progmodes/ps-mode.el b/lisp/progmodes/ps-mode.el index b589cab9c2..7f9d880757 100644 --- a/lisp/progmodes/ps-mode.el +++ b/lisp/progmodes/ps-mode.el @@ -496,7 +496,7 @@ The keymap for this second window is: When Ghostscript encounters an error it displays an error message -with a file position. Clicking mouse-2 on this number will bring +with a file position. Clicking mouse-2 on this number will bring point to the corresponding spot in the PostScript window, if input to the interpreter was sent from that window. Typing \\\\[ps-run-goto-error] when the cursor is at the number has the same effect." @@ -606,7 +606,7 @@ Typing \\\\[ps-run-goto-error] when the cursor is at the number "To what column should text on current line be indented? Indentation is increased if the last token on the current line -defines the beginning of a group. These tokens are: { [ <<" +defines the beginning of a group. These tokens are: { [ <<" (save-excursion (beginning-of-line) (if (looking-at "[ \t]*\\(}\\|\\]\\|>>\\)") @@ -1068,7 +1068,7 @@ grestore (defun ps-run-goto-error () "Jump to buffer position read as integer at point. -Use line numbers if `ps-run-error-line-numbers' is not nil" +Use line numbers if `ps-run-error-line-numbers' is not nil." (interactive) (let ((p (point))) (unless (looking-at "[0-9]") diff --git a/lisp/progmodes/python.el b/lisp/progmodes/python.el index ec5d8c5551..ae5aff351c 100644 --- a/lisp/progmodes/python.el +++ b/lisp/progmodes/python.el @@ -4415,7 +4415,7 @@ returns will be used. If not FORCE-PROCESS is passed what (defvar-local python-eldoc-get-doc t "Non-nil means eldoc should fetch the documentation - automatically. Set to nil by `python-eldoc-function' if + automatically. Set to nil by `python-eldoc-function' if `python-eldoc-function-timeout-permanent' is non-nil and `python-eldoc-function' times out.") @@ -4427,7 +4427,7 @@ returns will be used. If not FORCE-PROCESS is passed what (defcustom python-eldoc-function-timeout-permanent t "Non-nil means that when `python-eldoc-function' times out -`python-eldoc-get-doc' will be set to nil" +`python-eldoc-get-doc' will be set to nil." :group 'python :type 'boolean :version "25.1") @@ -4445,7 +4445,7 @@ function returns then if longer return the documentation at the point automatically. Set `python-eldoc-get-doc' to t to reenable eldoc documentation -fetching" +fetching." (when python-eldoc-get-doc (with-timeout (python-eldoc-function-timeout (if python-eldoc-function-timeout-permanent diff --git a/lisp/shadowfile.el b/lisp/shadowfile.el index 72491b9980..6340c9f1d6 100644 --- a/lisp/shadowfile.el +++ b/lisp/shadowfile.el @@ -557,7 +557,7 @@ permanently, remove the group from `shadow-literal-groups' or (defun shadow-make-group (regexp sites) "Make a description of a file group--- actually a list of regexp Tramp file names---from REGEXP (name of file to -be shadowed), and list of SITES" +be shadowed), and list of SITES." (if sites (cons (shadow-make-fullname (shadow-parse-name (shadow-site-primary (car sites))) nil regexp) diff --git a/lisp/speedbar.el b/lisp/speedbar.el index 52ae5d2da5..e4e6734994 100644 --- a/lisp/speedbar.el +++ b/lisp/speedbar.el @@ -555,7 +555,7 @@ current file, and the FILENAME of the file being checked." (defcustom speedbar-obj-do-check t "Non-nil check all files in speedbar to see if they have an object file. Any file checked out is marked with `speedbar-obj-indicator', and the -marking is based on `speedbar-obj-alist'" +marking is based on `speedbar-obj-alist'." :group 'speedbar-vc :type 'boolean) diff --git a/lisp/textmodes/flyspell.el b/lisp/textmodes/flyspell.el index bae0283497..ce788207cf 100644 --- a/lisp/textmodes/flyspell.el +++ b/lisp/textmodes/flyspell.el @@ -2103,7 +2103,7 @@ spell-check." ;;*---------------------------------------------------------------------*/ (defun flyspell-auto-correct-previous-hook () "Hook to track successive calls to `flyspell-auto-correct-previous-word'. -Sets `flyspell-auto-correct-previous-pos' to nil" +Sets `flyspell-auto-correct-previous-pos' to nil." (interactive) (remove-hook 'pre-command-hook (function flyspell-auto-correct-previous-hook) t) (unless (eq this-command (function flyspell-auto-correct-previous-word)) diff --git a/lisp/textmodes/reftex-cite.el b/lisp/textmodes/reftex-cite.el index 5b42b25f77..9d45f9aba7 100644 --- a/lisp/textmodes/reftex-cite.el +++ b/lisp/textmodes/reftex-cite.el @@ -74,7 +74,7 @@ The expanded value is cached." ;;;###autoload (defun reftex-bib-or-thebib () "Test if BibTeX or \\begin{thebibliography} should be used for the citation. -Find the bof of the current file" +Find the bof of the current file." (let* ((docstruct (symbol-value reftex-docstruct-symbol)) (rest (or (member (list 'bof (buffer-file-name)) docstruct) docstruct)) diff --git a/lisp/textmodes/reftex-index.el b/lisp/textmodes/reftex-index.el index 9f5242a6f5..cf94600193 100644 --- a/lisp/textmodes/reftex-index.el +++ b/lisp/textmodes/reftex-index.el @@ -771,7 +771,7 @@ Label context is only displayed when the labels are there as well." (interactive) (reftex-index-visit-location 'hide)) (defun reftex-index-goto-entry () - "Go to document location in other window. *Index* window stays." + "Go to document location in other window. *Index* window stays." (interactive) (reftex-index-visit-location t)) (defun reftex-index-mouse-goto-line-and-hide (ev) @@ -1093,12 +1093,12 @@ When index is restricted, select the previous section as restriction criterion." (reftex-index-change-entry new (format "Removed prefix: %s" prefix)))) (defun reftex-index-kill () - "FIXME: Not yet implemented" + "FIXME: Not yet implemented." (interactive) (error "This function is currently not implemented")) (defun reftex-index-undo () - "FIXME: Not yet implemented" + "FIXME: Not yet implemented." (interactive) (error "This function is currently not implemented")) diff --git a/lisp/textmodes/reftex-parse.el b/lisp/textmodes/reftex-parse.el index 005816e965..eb8446f4c4 100644 --- a/lisp/textmodes/reftex-parse.el +++ b/lisp/textmodes/reftex-parse.el @@ -1013,7 +1013,7 @@ OPT-ARGS is a list of argument numbers which are optional." (defun reftex-context-substring (&optional to-end) "Return up to 150 chars from point. -When point is just after a { or [, limit string to matching parenthesis" +When point is just after a { or [, limit string to matching parenthesis." (cond (to-end ;; Environment - find next \end diff --git a/lisp/textmodes/reftex.el b/lisp/textmodes/reftex.el index d763769a18..bec86840c0 100644 --- a/lisp/textmodes/reftex.el +++ b/lisp/textmodes/reftex.el @@ -390,7 +390,7 @@ If the symbols for the current master file do not exist, they are created." (buffer-file-name))))) (cond ((null master) - (error "Need a filename for this buffer, please save it first")) + (error "Need a filename for this buffer, please save it first")) ((or (file-exists-p (concat master ".tex")) (reftex-get-buffer-visiting (concat master ".tex"))) ;; Ahh, an extra .tex was missing... diff --git a/lisp/textmodes/rst.el b/lisp/textmodes/rst.el index ba5d7e4f46..88c44c06da 100644 --- a/lisp/textmodes/rst.el +++ b/lisp/textmodes/rst.el @@ -1904,7 +1904,7 @@ includes indentation and correct length of adornment lines." "Return the next best `rst-Hdr' upward from HDR. Consider existing hierarchy HIER and preferred headers. PREV may be a previous `rst-Hdr' which may be taken into account. If DOWN -return the next best `rst-Hdr' downward instead. Return nil in +return the next best `rst-Hdr' downward instead. Return nil if HIER is nil." (let* ((normalized-hier (if down hier @@ -2878,7 +2878,7 @@ file-write hook to always make it up-to-date automatically." ;; testcover: ok. "Display a table of contents for current buffer. Displays all section titles found in the current buffer in a -hierarchical list. The resulting buffer can be navigated, and +hierarchical list. The resulting buffer can be navigated, and selecting a section title moves the cursor to that section." (interactive) (rst-reset-section-caches) @@ -3397,7 +3397,7 @@ Region is from BEG to END. Uncomment if ARG." (defun rst-uncomment-region (beg end &optional _arg) "Uncomment the current region. -Region is from BEG to END. _ARG is ignored" +Region is from BEG to END. _ARG is ignored." (save-excursion (goto-char beg) (rst-forward-line-strict 0) @@ -4003,7 +4003,7 @@ to `font-lock-end'." (defun rst-font-lock-extend-region-internal (beg end) "Check the region BEG / END for being in the middle of a multi-line construct. -Return nil if not or a cons with new values for BEG / END" +Return nil if not or a cons with new values for BEG / END." (let ((nbeg (rst-font-lock-extend-region-extend beg -1)) (nend (rst-font-lock-extend-region-extend end 1))) (if (or nbeg nend) diff --git a/lisp/thumbs.el b/lisp/thumbs.el index 6a17a75654..2b1eb4630d 100644 --- a/lisp/thumbs.el +++ b/lisp/thumbs.el @@ -758,7 +758,7 @@ ACTION and ARG should be a valid convert command." (put 'thumbs-mode 'mode-class 'special) (define-derived-mode thumbs-mode fundamental-mode "thumbs" - "Preview images in a thumbnails buffer" + "Preview images in a thumbnails buffer." (setq buffer-read-only t)) (defvar thumbs-view-image-mode-map diff --git a/lisp/vc/ediff-util.el b/lisp/vc/ediff-util.el index 796027dead..ee6631dc3a 100644 --- a/lisp/vc/ediff-util.el +++ b/lisp/vc/ediff-util.el @@ -2207,7 +2207,7 @@ ARG is a prefix argument. If nil, copy the current difference region." "Restore ARGth diff from `ediff-killed-diffs-alist'. ARG is a prefix argument. If ARG is nil, restore the current-difference. If the second optional argument, a character, is given, use it to -determine the target buffer instead of (ediff-last-command-char)" +determine the target buffer instead of `ediff-last-command-char'." (interactive "P") (ediff-barf-if-not-control-buffer) (if (numberp arg) diff --git a/lisp/vc/pcvs-defs.el b/lisp/vc/pcvs-defs.el index 7065b8dfe7..8cac61a7d4 100644 --- a/lisp/vc/pcvs-defs.el +++ b/lisp/vc/pcvs-defs.el @@ -86,8 +86,8 @@ will select a shared-flag.") (defvar cvs-cvsroot nil "Specifies where the (current) cvs master repository is. Overrides the environment variable $CVSROOT by sending \" -d dir\" to -all CVS commands. This switch is useful if you have multiple CVS -repositories. It can be set interactively with \\[cvs-change-cvsroot.] +all CVS commands. This switch is useful if you have multiple CVS +repositories. It can be set interactively with \\[cvs-change-cvsroot.] There is no need to set this if $CVSROOT is set to a correct value.") (defcustom cvs-auto-remove-handled nil @@ -120,7 +120,7 @@ If `empty', only non-empty directories will be shown." "If non-nil, tagging can only be applied to directories. Tagging should generally be applied a directory at a time, but sometimes it is useful to be able to tag a single file. The normal way to do that is to use -`cvs-mode-force-command' so as to temporarily override the restrictions," +`cvs-mode-force-command' so as to temporarily override the restrictions." :group 'pcl-cvs :type '(boolean)) diff --git a/lisp/vc/vc-hg.el b/lisp/vc/vc-hg.el index c2a5a6f70c..61d5ee1d3a 100644 --- a/lisp/vc/vc-hg.el +++ b/lisp/vc/vc-hg.el @@ -898,7 +898,7 @@ REPO must be the directory name of an hg repository." :file-sources (nreverse vc-hg--hgignore-filenames)))) (defun vc-hg--ignore-patterns-valid-p (hgip) - "Return whether the cached ignore patterns in HGIP are still valid" + "Return whether the cached ignore patterns in HGIP are still valid." (let ((valid t) (file-sources (vc-hg--ignore-patterns-file-sources hgip))) (while (and file-sources valid) diff --git a/lisp/wid-edit.el b/lisp/wid-edit.el index 7ed7b81280..2978dc8037 100644 --- a/lisp/wid-edit.el +++ b/lisp/wid-edit.el @@ -1939,7 +1939,7 @@ the earlier input." widget)) (defun widget-field-value-set (widget value) - "Set an editable text field WIDGET to VALUE" + "Set an editable text field WIDGET to VALUE." (let ((from (widget-field-start widget)) (to (widget-field-text-end widget)) (buffer (widget-field-buffer widget))) @@ -3051,7 +3051,7 @@ as the value." "History of input to `widget-string-prompt-value'.") (define-widget 'string 'editable-field - "A string" + "A string." :tag "String" :format "%{%t%}: %v" :complete-function 'ispell-complete-word diff --git a/lisp/x-dnd.el b/lisp/x-dnd.el index e4e2dec3b8..6463594687 100644 --- a/lisp/x-dnd.el +++ b/lisp/x-dnd.el @@ -433,13 +433,13 @@ otherwise return the frame coordinates." (selection-symbol target-type &optional time-stamp terminal)) (defun x-dnd-version-from-flags (flags) - "Return the version byte from the 32 bit FLAGS in an XDndEnter message" + "Return the version byte from the 32 bit FLAGS in an XDndEnter message." (if (consp flags) ;; Long as cons (ash (car flags) -8) (ash flags -24))) ;; Ordinary number (defun x-dnd-more-than-3-from-flags (flags) - "Return the nmore-than3 bit from the 32 bit FLAGS in an XDndEnter message" + "Return the nmore-than3 bit from the 32 bit FLAGS in an XDndEnter message." (if (consp flags) (logand (cdr flags) 1) (logand flags 1))) commit 80b53a3b8dcc28d18ac9a7adacf377ebe6d23ffe Author: Lars Ingebrigtsen Date: Sat Sep 21 00:19:11 2019 +0200 Make register-preview ignore empty registers * lisp/register.el (register-preview): Ignore elements that are empty (bug#37155). diff --git a/lisp/register.el b/lisp/register.el index 775e1a2cc9..b4d9d0d01c 100644 --- a/lisp/register.el +++ b/lisp/register.el @@ -139,7 +139,10 @@ Format of each entry is controlled by the variable `register-preview-function'." nil (with-current-buffer standard-output (setq cursor-in-non-selected-windows nil) - (insert (mapconcat register-preview-function register-alist "")))))) + (mapc (lambda (elem) + (when (get-register (car elem)) + (insert (funcall register-preview-function elem)))) + register-alist))))) (defun register-read-with-preview (prompt) "Read and return a register name, possibly showing existing registers. commit 7c3ef77ccbc144a269b2a45ec855647290c8e0d0 Author: Johan Claesson Date: Sat Sep 21 00:06:58 2019 +0200 Make the reverse tabulated list sort stable * lisp/emacs-lisp/tabulated-list.el (tabulated-list--get-sorter): Make the reverse sorting stable (bug#37174). Copyright-paperwork-exempt: yes diff --git a/lisp/emacs-lisp/tabulated-list.el b/lisp/emacs-lisp/tabulated-list.el index 63ae1f8c07..f30e2c0ec8 100644 --- a/lisp/emacs-lisp/tabulated-list.el +++ b/lisp/emacs-lisp/tabulated-list.el @@ -373,7 +373,7 @@ column. Negate the predicate that would be returned if (if (stringp b) b (car b))))))) ;; Reversed order. (if (cdr tabulated-list-sort-key) - (lambda (a b) (not (funcall sorter a b))) + (lambda (a b) (funcall sorter b a)) sorter)))) (defsubst tabulated-list--col-local-max-widths (col) commit 280cf93f313925375cf57d1d64bfbe940f950452 Author: Lars Ingebrigtsen Date: Fri Sep 20 23:57:34 2019 +0200 Further touch-ups to the auth-source obfuscation * lisp/auth-source.el (auth-source--obfuscate): Avoid leaking the length of the password by using PKCS#7 padding. diff --git a/lisp/auth-source.el b/lisp/auth-source.el index 365ed2fa28..464facdeaf 100644 --- a/lisp/auth-source.el +++ b/lisp/auth-source.el @@ -1172,42 +1172,45 @@ FILE is the file from which we obtained this token." ;; have to call `auth-source-forget-all-cached'. (unless auth-source--session-nonce (setq auth-source--session-nonce - (apply #'string (cl-loop repeat 32 + (apply #'string (cl-loop repeat 16 collect (random 128))))) (if (and (fboundp 'gnutls-symmetric-encrypt) (gnutls-available-p)) (let ((cdata (car (last (gnutls-ciphers))))) (mapconcat #'base64-encode-string - (append - (list (format "%d" (length string))) - (gnutls-symmetric-encrypt - (pop cdata) - (auth-source--pad auth-source--session-nonce - (plist-get cdata :cipher-keysize)) - (list 'iv-auto (plist-get cdata :cipher-ivsize)) - (auth-source--pad string (plist-get cdata :cipher-blocksize)))) + (gnutls-symmetric-encrypt + (pop cdata) + (auth-source--pad auth-source--session-nonce + (plist-get cdata :cipher-keysize)) + (list 'iv-auto (plist-get cdata :cipher-ivsize)) + (auth-source--pad string (plist-get cdata :cipher-blocksize))) "-")) (mapcar #'1- string))) -(defun auth-source--pad (s length) +(defun auth-source--pad (string length) "Pad string S to a modulo of LENGTH." - (concat s (make-string (- length (mod (length s) length)) ?\0))) + (let ((pad (- length (mod (length string) length)))) + (concat string (make-string pad pad)))) + +(defun auth-source--unpad (string) + "Remove PKCS#7 padding from STRING." + (substring string 0 (- (length string) + (aref string (1- (length string)))))) (defun auth-source--deobfuscate (data) (if (and (fboundp 'gnutls-symmetric-encrypt) (gnutls-available-p)) (let ((cdata (car (last (gnutls-ciphers)))) (bits (split-string data "-"))) - (substring + (auth-source--unpad (car (gnutls-symmetric-decrypt (pop cdata) (auth-source--pad auth-source--session-nonce (plist-get cdata :cipher-keysize)) - (base64-decode-string (caddr bits)) - (base64-decode-string (cadr bits)))) - 0 (string-to-number (base64-decode-string (car bits))))) + (base64-decode-string (cadr bits)) + (base64-decode-string (car bits)))))) (apply #'string (mapcar #'1+ data)))) (cl-defun auth-source-netrc-search (&rest spec commit c3958e48f6a257fa7e681b2b39ea83d677bcb2f3 Author: Lars Ingebrigtsen Date: Fri Sep 20 22:24:56 2019 +0200 Add some comments to the auth-source obfuscation * lisp/auth-source.el (auth-source--obfuscate): Add comments. diff --git a/lisp/auth-source.el b/lisp/auth-source.el index e608afca2d..365ed2fa28 100644 --- a/lisp/auth-source.el +++ b/lisp/auth-source.el @@ -1164,9 +1164,15 @@ FILE is the file from which we obtained this token." (defvar auth-source--session-nonce nil) (defun auth-source--obfuscate (string) + ;; We want to keep passwords out of backtraces and bug reports and + ;; the like, so if we have GnuTLS available, we encrypt them with a + ;; nonce that we just keep in memory. If somebody has access to the + ;; current Emacs session, they can be decrypted, but if not, little + ;; useful information is leaked. If you reset the nonce, you also + ;; have to call `auth-source-forget-all-cached'. (unless auth-source--session-nonce (setq auth-source--session-nonce - (apply #'string (cl-loop repeat 10 + (apply #'string (cl-loop repeat 32 collect (random 128))))) (if (and (fboundp 'gnutls-symmetric-encrypt) (gnutls-available-p)) commit 76c14b7191f5c30ceeb06a546b44b3bac03ea8e0 Author: Lars Ingebrigtsen Date: Fri Sep 20 22:18:10 2019 +0200 Make previous auth-source change not break on Windows without gnutls * lisp/auth-source.el (auth-source--obfuscate) (auth-source--deobfuscate): Check that gnutls is really available. diff --git a/lisp/auth-source.el b/lisp/auth-source.el index a049e05e4d..e608afca2d 100644 --- a/lisp/auth-source.el +++ b/lisp/auth-source.el @@ -1168,7 +1168,8 @@ FILE is the file from which we obtained this token." (setq auth-source--session-nonce (apply #'string (cl-loop repeat 10 collect (random 128))))) - (if (fboundp 'gnutls-symmetric-encrypt) + (if (and (fboundp 'gnutls-symmetric-encrypt) + (gnutls-available-p)) (let ((cdata (car (last (gnutls-ciphers))))) (mapconcat #'base64-encode-string @@ -1188,7 +1189,8 @@ FILE is the file from which we obtained this token." (concat s (make-string (- length (mod (length s) length)) ?\0))) (defun auth-source--deobfuscate (data) - (if (fboundp 'gnutls-symmetric-encrypt) + (if (and (fboundp 'gnutls-symmetric-encrypt) + (gnutls-available-p)) (let ((cdata (car (last (gnutls-ciphers)))) (bits (split-string data "-"))) (substring commit 46b49d9ece4ef6a14d661abd261d9cbeff1f237b Author: Lars Ingebrigtsen Date: Fri Sep 20 22:10:47 2019 +0200 Obfuscate auth-source memory contents even more * lisp/auth-source.el (auth-source--deobfuscate): Use more obfuscated obfuscation (bug#37196). (auth-source--pad, auth-source--obfuscate) (auth-source-netrc-normalize): Use it. (auth-source-netrc-parse): Ditto. diff --git a/lisp/auth-source.el b/lisp/auth-source.el index 83ed90a87f..a049e05e4d 100644 --- a/lisp/auth-source.el +++ b/lisp/auth-source.el @@ -956,14 +956,13 @@ Note that the MAX parameter is used so we can exit the parse early." (insert (funcall cached-secrets))) (insert-file-contents file) ;; cache all netrc files (used to be just .gpg files) - ;; Store the contents of the file heavily encrypted in memory. - ;; (note for the irony-impaired: they are just obfuscated) + ;; Store the contents of the file obfuscated in memory. (auth-source--aput auth-source-netrc-cache file (list :mtime (file-attribute-modification-time (file-attributes file)) - :secret (let ((v (mapcar #'1+ (buffer-string)))) - (lambda () (apply #'string (mapcar #'1- v))))))) + :secret (let ((v (auth-source--obfuscate (buffer-string)))) + (lambda () (auth-source--deobfuscate v)))))) (goto-char (point-min)) (let ((entries (auth-source-netrc-parse-entries check max)) alist) @@ -1138,7 +1137,7 @@ FILE is the file from which we obtained this token." ;; showing the passwords in clear text in backtraces ;; and the like. (when (equal k "secret") - (setq v (let ((lexv (mapcar #'1+ v)) + (setq v (let ((lexv (auth-source--obfuscate v)) (token-decoder nil)) (when (string-match "^gpg:" v) ;; it's a GPG token: create a token decoder @@ -1153,15 +1152,56 @@ FILE is the file from which we obtained this token." (lambda () (if token-decoder (funcall token-decoder - (apply #'string - (mapcar #'1- lexv))) - (apply #'string (mapcar #'1- lexv))))))) + (auth-source--deobfuscate lexv)) + (auth-source--deobfuscate lexv)))))) (setq ret (plist-put ret (auth-source--symbol-keyword k) v)))) ret)) alist)) +;; Never change this variable. +(defvar auth-source--session-nonce nil) + +(defun auth-source--obfuscate (string) + (unless auth-source--session-nonce + (setq auth-source--session-nonce + (apply #'string (cl-loop repeat 10 + collect (random 128))))) + (if (fboundp 'gnutls-symmetric-encrypt) + (let ((cdata (car (last (gnutls-ciphers))))) + (mapconcat + #'base64-encode-string + (append + (list (format "%d" (length string))) + (gnutls-symmetric-encrypt + (pop cdata) + (auth-source--pad auth-source--session-nonce + (plist-get cdata :cipher-keysize)) + (list 'iv-auto (plist-get cdata :cipher-ivsize)) + (auth-source--pad string (plist-get cdata :cipher-blocksize)))) + "-")) + (mapcar #'1- string))) + +(defun auth-source--pad (s length) + "Pad string S to a modulo of LENGTH." + (concat s (make-string (- length (mod (length s) length)) ?\0))) + +(defun auth-source--deobfuscate (data) + (if (fboundp 'gnutls-symmetric-encrypt) + (let ((cdata (car (last (gnutls-ciphers)))) + (bits (split-string data "-"))) + (substring + (car + (gnutls-symmetric-decrypt + (pop cdata) + (auth-source--pad auth-source--session-nonce + (plist-get cdata :cipher-keysize)) + (base64-decode-string (caddr bits)) + (base64-decode-string (cadr bits)))) + 0 (string-to-number (base64-decode-string (car bits))))) + (apply #'string (mapcar #'1+ data)))) + (cl-defun auth-source-netrc-search (&rest spec &key backend require create type max host user port commit a420f13155b71b68b964a51ff326ccdf441c2811 Author: Lars Ingebrigtsen Date: Fri Sep 20 21:25:47 2019 +0200 Obfuscate auth-source secrets more * lisp/auth-source.el (auth-source-netrc-normalize): Obfuscate passwords stored in the lexical closure (bug#37196). diff --git a/lisp/auth-source.el b/lisp/auth-source.el index 7d8657da11..83ed90a87f 100644 --- a/lisp/auth-source.el +++ b/lisp/auth-source.el @@ -1132,11 +1132,15 @@ FILE is the file from which we obtained this token." ((member k '("password")) "secret") (t k))) - ;; send back the secret in a function (lexical binding) + ;; Send back the secret in a function (lexical + ;; binding). We slightly obfuscate the passwords + ;; (that's the "(mapcar #+' ..)" stuff) to avoid + ;; showing the passwords in clear text in backtraces + ;; and the like. (when (equal k "secret") - (setq v (let ((lexv v) + (setq v (let ((lexv (mapcar #'1+ v)) (token-decoder nil)) - (when (string-match "^gpg:" lexv) + (when (string-match "^gpg:" v) ;; it's a GPG token: create a token decoder ;; which unsets itself once (setq token-decoder @@ -1147,9 +1151,11 @@ FILE is the file from which we obtained this token." filename) (setq token-decoder nil))))) (lambda () - (when token-decoder - (setq lexv (funcall token-decoder lexv))) - lexv)))) + (if token-decoder + (funcall token-decoder + (apply #'string + (mapcar #'1- lexv))) + (apply #'string (mapcar #'1- lexv))))))) (setq ret (plist-put ret (auth-source--symbol-keyword k) v)))) commit 6d50010b34dbbcb90a7b4512f97e07fd8beceea5 Author: Stefan Kangas Date: Mon Sep 16 10:45:14 2019 +0200 Recommend against SHA-1 and MD5 for security * doc/lispref/text.texi (Checksum/Hash): * src/fns.c (Fmd5, Fsecure_hash): * lisp/subr.el (sha1): Doc fix to recommend against SHA-1 and MD5 for security-related applications, since they are not collision resistant. (Bug#37420) diff --git a/doc/lispref/text.texi b/doc/lispref/text.texi index 7ce54f59c6..955ad6130c 100644 --- a/doc/lispref/text.texi +++ b/doc/lispref/text.texi @@ -4710,12 +4710,12 @@ that you have an unaltered copy of that data. SHA-1, SHA-2, SHA-224, SHA-256, SHA-384 and SHA-512. MD5 is the oldest of these algorithms, and is commonly used in @dfn{message digests} to check the integrity of messages transmitted over a -network. MD5 is not collision resistant (i.e., it is possible to -deliberately design different pieces of data which have the same MD5 -hash), so you should not used it for anything security-related. A -similar theoretical weakness also exists in SHA-1. Therefore, for -security-related applications you should use the other hash types, -such as SHA-2. +network. MD5 and SHA-1 are not collision resistant (i.e., it is +possible to deliberately design different pieces of data which have +the same MD5 or SHA-1 hash), so you should not use them for anything +security-related. For security-related applications you should use +the other hash types, such as SHA-2 (e.g. @code{sha256} or +@code{sha512}). @defun secure-hash-algorithms This function returns a list of symbols representing algorithms that diff --git a/lisp/subr.el b/lisp/subr.el index 0b47da884b..45b99a82d2 100644 --- a/lisp/subr.el +++ b/lisp/subr.el @@ -3120,11 +3120,15 @@ Otherwise, return nil." raw-field))) (defun sha1 (object &optional start end binary) - "Return the SHA1 (Secure Hash Algorithm) of an OBJECT. + "Return the SHA-1 (Secure Hash Algorithm) of an OBJECT. OBJECT is either a string or a buffer. Optional arguments START and END are character positions specifying which portion of OBJECT for computing the hash. If BINARY is non-nil, return a string in binary -form." +form. + +Note that SHA-1 is not collision resistant and should not be used +for anything security-related. See `secure-hash' for +alternatives." (secure-hash 'sha1 object start end binary)) (defun function-get (f prop &optional autoload) diff --git a/src/fns.c b/src/fns.c index f45c729cfa..2314b4699e 100644 --- a/src/fns.c +++ b/src/fns.c @@ -5376,7 +5376,10 @@ If OBJECT is a string, the most preferred coding system (see the command `prefer-coding-system') is used. If NOERROR is non-nil, silently assume the `raw-text' coding if the -guesswork fails. Normally, an error is signaled in such case. */) +guesswork fails. Normally, an error is signaled in such case. + +Note that MD5 is not collision resistant and should not be used for +anything security-related. See `secure-hash' for alternatives. */) (Lisp_Object object, Lisp_Object start, Lisp_Object end, Lisp_Object coding_system, Lisp_Object noerror) { return secure_hash (Qmd5, object, start, end, coding_system, noerror, Qnil); @@ -5393,7 +5396,11 @@ whole OBJECT. The full list of algorithms can be obtained with `secure-hash-algorithms'. -If BINARY is non-nil, returns a string in binary form. */) +If BINARY is non-nil, returns a string in binary form. + +Note that MD5 and SHA-1 are not collision resistant and should not be +used for anything security-related. For these applications, use one +of the other hash types instead, e.g. sha256 or sha512. */) (Lisp_Object algorithm, Lisp_Object object, Lisp_Object start, Lisp_Object end, Lisp_Object binary) { return secure_hash (algorithm, object, start, end, Qnil, Qnil, binary); commit b8e9baac9ada62c2ea7437579df4be9d4f437fda Author: Lars Ingebrigtsen Date: Fri Sep 20 20:19:28 2019 +0200 Allow `process-contact' not to block * doc/lispref/processes.texi (Process Information): Document it. * lisp/simple.el (list-processes--refresh): Don't wait for contact information for non-setup processes. * src/process.c (Fprocess_contact): Take an optional parameter to avoid blocking (bug#37408). diff --git a/doc/lispref/processes.texi b/doc/lispref/processes.texi index 61de77d066..4c7853bae8 100644 --- a/doc/lispref/processes.texi +++ b/doc/lispref/processes.texi @@ -1042,7 +1042,7 @@ this is either @code{nil}, which means the process is running or @end smallexample @end defun -@defun process-contact process &optional key +@defun process-contact process &optional key no-block This function returns information about how a network, a serial, or a pipe connection was set up. When @var{key} is @code{nil}, it returns @code{(@var{hostname} @var{service})} for a network connection, @@ -1086,6 +1086,11 @@ connection, see @code{make-pipe-process} for the list of keys. If @var{key} is a keyword, the function returns the value corresponding to that keyword. + +If @var{process} is a non-blocking network stream that hasn't been +fully set up yet, then this function will block until that has +happened. If given the optional @var{no-block} parameter, this +function will return @code{nil} instead of blocking. @end defun @defun process-id process diff --git a/etc/NEWS b/etc/NEWS index 567f3cbb40..e8d3dffd3b 100644 --- a/etc/NEWS +++ b/etc/NEWS @@ -2130,6 +2130,10 @@ valid event type. * Lisp Changes in Emacs 27.1 ++++ +** 'process-contact' now takes an optional NO-BLOCK parameter to allow +not waiting for a process to be set up. + +++ ** The new 'quit-window-hook' is now run first when executing the 'quit-window' command. diff --git a/lisp/simple.el b/lisp/simple.el index 358b6a4f20..a267200aeb 100644 --- a/lisp/simple.el +++ b/lisp/simple.el @@ -4107,7 +4107,7 @@ Also, delete any process that is exited or signaled." (t "--"))) (cmd (if (memq type '(network serial)) - (let ((contact (process-contact p t))) + (let ((contact (process-contact p t t))) (if (eq type 'network) (format "(%s %s)" (if (plist-get contact :type) diff --git a/src/process.c b/src/process.c index 372277a953..a95192d8fb 100644 --- a/src/process.c +++ b/src/process.c @@ -1456,7 +1456,7 @@ DEFUN ("process-query-on-exit-flag", } DEFUN ("process-contact", Fprocess_contact, Sprocess_contact, - 1, 2, 0, + 1, 3, 0, doc: /* Return the contact info of PROCESS; t for a real child. For a network or serial or pipe connection, the value depends on the optional KEY arg. If KEY is nil, value is a cons cell of the form @@ -1465,9 +1465,12 @@ connection; it is t for a pipe connection. If KEY is t, the complete contact information for the connection is returned, else the specific value for the keyword KEY is returned. See `make-network-process', `make-serial-process', or `make-pipe-process' for the list of keywords. + If PROCESS is a non-blocking network process that hasn't been fully -set up yet, this function will block until socket setup has completed. */) - (Lisp_Object process, Lisp_Object key) +set up yet, this function will block until socket setup has completed. +If the optional NO-BLOCK parameter is specified, return nil instead of +waiting for the process to be fully set up.*/) + (Lisp_Object process, Lisp_Object key, Lisp_Object no_block) { Lisp_Object contact; @@ -1476,8 +1479,15 @@ set up yet, this function will block until socket setup has completed. */) #ifdef DATAGRAM_SOCKETS - if (NETCONN_P (process)) - wait_for_socket_fds (process, "process-contact"); + if (NETCONN_P (process) && XPROCESS (process)->infd < 0) + { + /* Usually wait for the network process to finish being set + * up. */ + if (!NILP (no_block)) + return Qnil; + + wait_for_socket_fds (process, "process-contact"); + } if (DATAGRAM_CONN_P (process) && (EQ (key, Qt) || EQ (key, QCremote))) commit 385bb140de767ff59b026f5540e0e8bfae53fb55 Author: Lars Ingebrigtsen Date: Fri Sep 20 19:37:54 2019 +0200 Make number-at-point recognize some hex numbers * lisp/thingatpt.el (number-at-point): Also return common hex numbers (bug#37458). diff --git a/etc/NEWS b/etc/NEWS index c129e8a0b6..567f3cbb40 100644 --- a/etc/NEWS +++ b/etc/NEWS @@ -1661,6 +1661,10 @@ backtrace with 'b'. A symbol 'uuid' can be passed to 'thing-at-point' and it returns the UUID at point. +--- +*** 'number-at-point' will now recognize hex number like 0xAb09 and #xAb09 +and return them as numbers. + --- *** 'word-at-point' and 'sentence-at-point' accept NO-PROPERTIES. Just like 'thing-at-point' itself. diff --git a/lisp/thingatpt.el b/lisp/thingatpt.el index 319f4b2cf8..1ce4b98fd1 100644 --- a/lisp/thingatpt.el +++ b/lisp/thingatpt.el @@ -632,10 +632,17 @@ Signal an error if the entire string was not used." (if thing (intern thing)))) ;;;###autoload (defun number-at-point () - "Return the number at point, or nil if none is found." - (when (thing-at-point-looking-at "-?[0-9]+\\.?[0-9]*" 500) - (string-to-number - (buffer-substring (match-beginning 0) (match-end 0))))) + "Return the number at point, or nil if none is found. +Decimal numbers like \"14\" or \"-14.5\", as well as hex numbers +like \"0xBEEF09\" or \"#xBEEF09\", are regognized." + (when (thing-at-point-looking-at + "\\(-?[0-9]+\\.?[0-9]*\\)\\|\\(0x\\|#x\\)\\([a-zA-Z0-9]+\\)" 500) + (if (match-beginning 1) + (string-to-number + (buffer-substring (match-beginning 1) (match-end 1))) + (string-to-number + (buffer-substring (match-beginning 3) (match-end 3)) + 16)))) (put 'number 'thing-at-point 'number-at-point) ;;;###autoload commit 1646e448d02195726cd44b0a8fb34c595b193a43 Author: Damien Cassou Date: Fri Sep 20 19:28:00 2019 +0200 Change default value of message-make-forward-subject-function * lisp/gnus/message.el (message-make-forward-subject-function): Change default value to be a list so it's easier for users to add functions. Change the type so the customize interface allows selecting multiple provided functions instead of just one (bug#37470). diff --git a/lisp/gnus/message.el b/lisp/gnus/message.el index 48d79107ea..9e0f2b461e 100644 --- a/lisp/gnus/message.el +++ b/lisp/gnus/message.el @@ -532,7 +532,7 @@ If t, use `message-user-organization-file'." :group 'message-headers) (defcustom message-make-forward-subject-function - #'message-forward-subject-name-subject + (list #'message-forward-subject-name-subject) "List of functions called to generate subject headers for forwarded messages. The subject generated by the previous function is passed into each successive function. @@ -547,10 +547,12 @@ The provided functions are: to it." :group 'message-forwarding :link '(custom-manual "(message)Forwarding") - :type '(radio (function-item message-forward-subject-author-subject) - (function-item message-forward-subject-fwd) - (function-item message-forward-subject-name-subject) - (repeat :tag "List of functions" function))) + :version "27.1" + :type '(repeat :tag "List of functions" + (radio (function-item message-forward-subject-author-subject) + (function-item message-forward-subject-fwd) + (function-item message-forward-subject-name-subject) + (function)))) (defcustom message-forward-as-mime nil "Non-nil means forward messages as an inline/rfc822 MIME section. commit f1f2de7cdfa5e20577bbc2e2bf29de4cce525002 Author: Stefan Kangas Date: Mon Sep 16 21:09:32 2019 +0200 Recommend using https for package-archives * lisp/emacs-lisp/package.el (package-archives): Recommend using https sources where possible. (Bug#33825) diff --git a/lisp/emacs-lisp/package.el b/lisp/emacs-lisp/package.el index ef0c5171de..1e136cb54f 100644 --- a/lisp/emacs-lisp/package.el +++ b/lisp/emacs-lisp/package.el @@ -214,7 +214,10 @@ Each element has the form (ID . LOCATION). (Other types of URL are currently not supported.) Only add locations that you trust, since fetching and installing -a package can run arbitrary code." +a package can run arbitrary code. + +HTTPS URLs should be used where possible, as they offer superior +security." :type '(alist :key-type (string :tag "Archive name") :value-type (string :tag "URL or directory name")) :risky t commit cc59e292cf070296df5d0f73eef48af32e71f5f0 Author: Michael Albinus Date: Fri Sep 20 17:29:08 2019 +0200 ; Improve wording of last Tramp commit, suggested by Robert Pluim diff --git a/doc/misc/tramp.texi b/doc/misc/tramp.texi index 1440521df5..ba0545c38d 100644 --- a/doc/misc/tramp.texi +++ b/doc/misc/tramp.texi @@ -805,8 +805,8 @@ behavior. Works like @option{ssh} but without the extra authentication prompts. @option{sshx} uses @samp{ssh -t -t @var{host} -l @var{user} /bin/sh} -to open a connection with a ``standard'' login shell. It supports to -change the remote login shell @command{/bin/sh}. +to open a connection with a ``standard'' login shell. It supports +changing the remote login shell @command{/bin/sh}. @strong{Note} that @option{sshx} does not bypass authentication questions. For example, if the host key of the remote host is not @@ -842,8 +842,7 @@ This is another method from the Kerberos suite. It behaves like @option{su}. @option{plink} method is for MS Windows users with the PuTTY implementation of SSH@. It uses @samp{plink -ssh} to log in to the -remote host. It supports to change the remote login shell -@command{/bin/sh}. +remote host. It supports changing the remote login shell @command{/bin/sh}. Check the @samp{Share SSH connections if possible} control for that session. @@ -857,7 +856,7 @@ session. Another method using PuTTY on MS Windows with session names instead of host names. @option{plinkx} calls @samp{plink -load @var{session} -t}. User names and port numbers must be defined in the session. It -supports to change the remote login shell @command{/bin/sh}. +supports changing the remote login shell @command{/bin/sh}. Check the @samp{Share SSH connections if possible} control for that session. @@ -932,7 +931,7 @@ This method supports the @samp{-p} argument. @option{scpx} is useful to avoid login shell questions. It is similar in performance to @option{scp}. @option{scpx} uses @samp{ssh -t -t @var{host} -l @var{user} /bin/sh} to open a connection. It supports -to change the remote login shell @command{/bin/sh}. +changing the remote login shell @command{/bin/sh}. @option{scpx} is useful for MS Windows users when @command{ssh} triggers an error about allocating a pseudo tty. This happens due to @@ -956,7 +955,7 @@ use the @command{plink} command to connect to the remote host, and they use @command{pscp} or @command{psftp} for transferring the files. These programs are part of PuTTY, an SSH implementation for MS Windows. -They support to change the remote login shell @command{/bin/sh}. +They support changing the remote login shell @command{/bin/sh}. Check the @samp{Share SSH connections if possible} control for that session. @@ -3776,7 +3775,7 @@ you want to use another value for @env{TERM}, change @code{tramp-terminal-type} and this line accordingly. Alternatively, you could set the remote login shell explicitly. See -@ref{Remote shell setup} for discussing this technique, +@ref{Remote shell setup} for discussion of this technique, When using fish shell on remote hosts, disable fancy formatting by adding the following to @file{~/.config/fish/config.fish}: diff --git a/lisp/net/tramp.el b/lisp/net/tramp.el index 934b5dd9d9..b044762b70 100644 --- a/lisp/net/tramp.el +++ b/lisp/net/tramp.el @@ -211,27 +211,35 @@ pair of the form (KEY VALUE). The following KEYs are defined: or the name of telnet or a workalike, or the name of su or a workalike. * `tramp-login-args' - This specifies the list of arguments to pass to the above - mentioned program. Please note that this is a list of list - of arguments, that is, normally you don't want to put \"-a - -b\" or \"-f foo\" here. Instead, you want a list (\"-a\" - \"-b\"), or (\"-f\" \"foo\"). There are some patterns: + This specifies a list of lists of arguments to pass to the + above mentioned program. You normally want to put each + argument in an individual string, i.e. + (\"-a\" \"-b\") rather than (\"-a -b\"). - - \"%h\" in this list is replaced by the host name + \"%\" followed by a letter are expanded in the arguments as + follows: + + - \"%h\" is replaced by the host name - \"%u\" is replaced by the user name - \"%p\" is replaced by the port number - \"%%\" can be used to obtain a literal percent character. - If a list containing \"%h\", \"%u\" or \"%p\" is unchanged - during expansion (i.e. no host, no user or no port - specified), this list is not used as argument. By this, - arguments like (\"-l\" \"%u\") are optional. + If a sub-list containing \"%h\", \"%u\" or \"%p\" is + unchanged after expansion (i.e. no host, no user or no port + were specified), that sublist is not used. For e.g. + + '((\"-a\" \"-b\") (\"-l\" \"%u\")) + + that means that (\"-l\" \"%u\") is used only if the user was + specified, and it is thus effectively optional. + + Other expansions are: - \"%l\" is replaced by the login shell `tramp-remote-shell' and its parameters. - \"%t\" is replaced by the temporary file name produced with `tramp-make-tramp-temp-file'. - - \"%k\" indicates the keep-date parameter of a program, if exists + - \"%k\" indicates the keep-date parameter of a program, if exists. - \"%c\" adds additional `tramp-ssh-controlmaster-options' options for the first hop. commit 8b1af4a0bf82a92374d4e8205057880f7d28ede9 Author: Matthew Newton Date: Fri Sep 20 15:01:47 2019 +0200 Fix the previous imenu commit * lisp/imenu.el (imenu--make-index-alist): Always return the alist (bug#30449). Copyright-paperwork-exempt: yes diff --git a/lisp/imenu.el b/lisp/imenu.el index 9df597b4d6..f8bfc4046c 100644 --- a/lisp/imenu.el +++ b/lisp/imenu.el @@ -510,7 +510,8 @@ See `imenu--index-alist' for the format of the index alist." "No items suitable for an index found in this buffer")) (or imenu--index-alist (setq imenu--index-alist (list nil))) - (unless imenu-auto-rescan + (if imenu-auto-rescan + imenu--index-alist ;; Add a rescan option to the index. (cons imenu--rescan-item imenu--index-alist))) commit 828233009a8c8dcbf58a561ca8fd06bd53198974 Author: Michael Albinus Date: Fri Sep 20 11:27:49 2019 +0200 Some Tramp methods allow to change the remote login shell * doc/misc/tramp.texi (Inline methods) : (External methods) : Mention, that the remote login shell could be changed. (Remote shell setup): Remove description of properties "remote-shell-login" and "remote-shell-args", they don't matter here. Changing the default remote shell works only for some methods. (Frequently Asked Questions): Refer to alternative approach fixing zsh problems. * etc/NEWS: Some Tramp methods allow to change the remote login shell. * lisp/net/tramp-sh.el (tramp-default-remote-shell): New defconst. (tramp-methods): Use it. (tramp-get-sh-extra-args): New defun. (tramp-open-shell, tramp-maybe-open-connection): Use it. * lisp/net/tramp.el (tramp-methods): Adapt docstring. diff --git a/doc/misc/tramp.texi b/doc/misc/tramp.texi index 1ed334b6bd..1440521df5 100644 --- a/doc/misc/tramp.texi +++ b/doc/misc/tramp.texi @@ -805,7 +805,8 @@ behavior. Works like @option{ssh} but without the extra authentication prompts. @option{sshx} uses @samp{ssh -t -t @var{host} -l @var{user} /bin/sh} -to open a connection with a ``standard'' login shell. +to open a connection with a ``standard'' login shell. It supports to +change the remote login shell @command{/bin/sh}. @strong{Note} that @option{sshx} does not bypass authentication questions. For example, if the host key of the remote host is not @@ -841,7 +842,8 @@ This is another method from the Kerberos suite. It behaves like @option{su}. @option{plink} method is for MS Windows users with the PuTTY implementation of SSH@. It uses @samp{plink -ssh} to log in to the -remote host. +remote host. It supports to change the remote login shell +@command{/bin/sh}. Check the @samp{Share SSH connections if possible} control for that session. @@ -854,7 +856,8 @@ session. Another method using PuTTY on MS Windows with session names instead of host names. @option{plinkx} calls @samp{plink -load @var{session} --t}. User names and port numbers must be defined in the session. +-t}. User names and port numbers must be defined in the session. It +supports to change the remote login shell @command{/bin/sh}. Check the @samp{Share SSH connections if possible} control for that session. @@ -928,7 +931,8 @@ This method supports the @samp{-p} argument. @option{scpx} is useful to avoid login shell questions. It is similar in performance to @option{scp}. @option{scpx} uses @samp{ssh -t -t -@var{host} -l @var{user} /bin/sh} to open a connection. +@var{host} -l @var{user} /bin/sh} to open a connection. It supports +to change the remote login shell @command{/bin/sh}. @option{scpx} is useful for MS Windows users when @command{ssh} triggers an error about allocating a pseudo tty. This happens due to @@ -952,6 +956,8 @@ use the @command{plink} command to connect to the remote host, and they use @command{pscp} or @command{psftp} for transferring the files. These programs are part of PuTTY, an SSH implementation for MS Windows. +They support to change the remote login shell @command{/bin/sh}. + Check the @samp{Share SSH connections if possible} control for that session. @@ -2100,12 +2106,10 @@ be recomputed. To force @value{tramp} to recompute afresh, call @cindex zsh setup Per default, @value{tramp} uses the command @command{/bin/sh} for -strting a shell on the remote host. This can be changed by setting +starting a shell on the remote host. This can be changed by setting the connection property @option{remote-shell}, see @xref{Predefined -connection information}. Other properties might be adapted as well, -like @option{remote-shell-login} or @option{remote-shell-args}. If -you want, for example, use @command{/usr/bin/zsh} on a remote host, -you might apply +connection information}. If you want, for example, use +@command{/usr/bin/zsh} on a remote host, you might apply @lisp @group @@ -2115,6 +2119,11 @@ you might apply @end group @end lisp +This works only for connection methods which allow to override the +remote login shell, like @option{sshx} or @option{plink}. See +@ref{Inline methods} and @ref{External methods} for connection methods +which support this. + This approach has also the advantage, that settings in @code{tramp-sh-extra-args} will be applied. For zsh, the trouble with the shell prompt due to set zle options will be avoided. @@ -3766,6 +3775,9 @@ This uses the default value of @code{tramp-terminal-type}, you want to use another value for @env{TERM}, change @code{tramp-terminal-type} and this line accordingly. +Alternatively, you could set the remote login shell explicitly. See +@ref{Remote shell setup} for discussing this technique, + When using fish shell on remote hosts, disable fancy formatting by adding the following to @file{~/.config/fish/config.fish}: diff --git a/etc/NEWS b/etc/NEWS index e0038e4084..c129e8a0b6 100644 --- a/etc/NEWS +++ b/etc/NEWS @@ -1530,6 +1530,12 @@ names are adjusted to the host name from the previous hop. timeout, after which the underlying session is disabled. This is for security reasons. ++++ +*** For some connection methods, like "sshx" or "plink", it is +possible to configure the remote login shell. This avoids problems +with remote hosts, where "/bin/sh" is a link to a shell which +cooperates badly with Tramp. + ** Rcirc --- diff --git a/lisp/net/tramp-sh.el b/lisp/net/tramp-sh.el index 8092f6a5cf..b7089207cb 100644 --- a/lisp/net/tramp-sh.el +++ b/lisp/net/tramp-sh.el @@ -37,6 +37,10 @@ (defvar vc-git-program) (defvar vc-hg-program) +;;;###tramp-autoload +(defconst tramp-default-remote-shell "/bin/sh" + "The default remote shell Tramp applies.") + ;;;###tramp-autoload (defcustom tramp-inline-compress-start-size 4096 "The minimum size of compressing where inline transfer. @@ -132,10 +136,10 @@ The string is used in `tramp-methods'.") ;;;###tramp-autoload (tramp--with-startup (add-to-list 'tramp-methods - '("rcp" + `("rcp" (tramp-login-program "rsh") (tramp-login-args (("%h") ("-l" "%u"))) - (tramp-remote-shell "/bin/sh") + (tramp-remote-shell ,tramp-default-remote-shell) (tramp-remote-shell-login ("-l")) (tramp-remote-shell-args ("-c")) (tramp-copy-program "rcp") @@ -143,35 +147,37 @@ The string is used in `tramp-methods'.") (tramp-copy-keep-date t) (tramp-copy-recursive t))) (add-to-list 'tramp-methods - '("remcp" + `("remcp" (tramp-login-program "remsh") (tramp-login-args (("%h") ("-l" "%u"))) - (tramp-remote-shell "/bin/sh") + (tramp-remote-shell ,tramp-default-remote-shell) (tramp-remote-shell-login ("-l")) (tramp-remote-shell-args ("-c")) (tramp-copy-program "rcp") (tramp-copy-args (("-p" "%k"))) (tramp-copy-keep-date t))) (add-to-list 'tramp-methods - '("scp" + `("scp" (tramp-login-program "ssh") (tramp-login-args (("-l" "%u") ("-p" "%p") ("%c") ("-e" "none") ("%h"))) (tramp-async-args (("-q"))) - (tramp-remote-shell "/bin/sh") + (tramp-remote-shell ,tramp-default-remote-shell) (tramp-remote-shell-login ("-l")) (tramp-remote-shell-args ("-c")) (tramp-copy-program "scp") - (tramp-copy-args (("-P" "%p") ("-p" "%k") ("-q") ("-r") ("%c"))) + (tramp-copy-args (("-P" "%p") ("-p" "%k") ("-q") + ("-r") ("%c"))) (tramp-copy-keep-date t) (tramp-copy-recursive t))) (add-to-list 'tramp-methods - '("scpx" + `("scpx" (tramp-login-program "ssh") (tramp-login-args (("-l" "%u") ("-p" "%p") ("%c") - ("-e" "none") ("-t" "-t") ("%h") ("/bin/sh"))) + ("-e" "none") ("-t" "-t") ("%h") + ("%l"))) (tramp-async-args (("-q"))) - (tramp-remote-shell "/bin/sh") + (tramp-remote-shell ,tramp-default-remote-shell) (tramp-remote-shell-login ("-l")) (tramp-remote-shell-args ("-c")) (tramp-copy-program "scp") @@ -180,64 +186,66 @@ The string is used in `tramp-methods'.") (tramp-copy-keep-date t) (tramp-copy-recursive t))) (add-to-list 'tramp-methods - '("rsync" + `("rsync" (tramp-login-program "ssh") (tramp-login-args (("-l" "%u") ("-p" "%p") ("%c") ("-e" "none") ("%h"))) (tramp-async-args (("-q"))) - (tramp-remote-shell "/bin/sh") + (tramp-remote-shell ,tramp-default-remote-shell) (tramp-remote-shell-login ("-l")) (tramp-remote-shell-args ("-c")) (tramp-copy-program "rsync") - (tramp-copy-args (("-t" "%k") ("-p") ("-r") ("-s") ("-c"))) + (tramp-copy-args (("-t" "%k") ("-p") ("-r") ("-s") + ("-c"))) (tramp-copy-env (("RSYNC_RSH") ("ssh" "%c"))) (tramp-copy-keep-date t) (tramp-copy-keep-tmpfile t) (tramp-copy-recursive t))) (add-to-list 'tramp-methods - '("rsh" + `("rsh" (tramp-login-program "rsh") (tramp-login-args (("%h") ("-l" "%u"))) - (tramp-remote-shell "/bin/sh") + (tramp-remote-shell ,tramp-default-remote-shell) (tramp-remote-shell-login ("-l")) (tramp-remote-shell-args ("-c")))) (add-to-list 'tramp-methods - '("remsh" + `("remsh" (tramp-login-program "remsh") (tramp-login-args (("%h") ("-l" "%u"))) - (tramp-remote-shell "/bin/sh") + (tramp-remote-shell ,tramp-default-remote-shell) (tramp-remote-shell-login ("-l")) (tramp-remote-shell-args ("-c")))) (add-to-list 'tramp-methods - '("ssh" + `("ssh" (tramp-login-program "ssh") (tramp-login-args (("-l" "%u") ("-p" "%p") ("%c") ("-e" "none") ("%h"))) (tramp-async-args (("-q"))) - (tramp-remote-shell "/bin/sh") + (tramp-remote-shell ,tramp-default-remote-shell) (tramp-remote-shell-login ("-l")) (tramp-remote-shell-args ("-c")))) (add-to-list 'tramp-methods - '("sshx" + `("sshx" (tramp-login-program "ssh") (tramp-login-args (("-l" "%u") ("-p" "%p") ("%c") - ("-e" "none") ("-t" "-t") ("%h") ("/bin/sh"))) + ("-e" "none") ("-t" "-t") ("%h") + ("%l"))) (tramp-async-args (("-q"))) - (tramp-remote-shell "/bin/sh") + (tramp-remote-shell ,tramp-default-remote-shell) (tramp-remote-shell-login ("-l")) (tramp-remote-shell-args ("-c")))) (add-to-list 'tramp-methods - '("telnet" + `("telnet" (tramp-login-program "telnet") (tramp-login-args (("%h") ("%p") ("2>/dev/null"))) - (tramp-remote-shell "/bin/sh") + (tramp-remote-shell ,tramp-default-remote-shell) (tramp-remote-shell-login ("-l")) (tramp-remote-shell-args ("-c")))) (add-to-list 'tramp-methods - '("nc" + `("nc" (tramp-login-program "telnet") (tramp-login-args (("%h") ("%p") ("2>/dev/null"))) - (tramp-remote-shell "/bin/sh") + (tramp-remote-shell ,tramp-default-remote-shell) (tramp-remote-shell-login ("-l")) (tramp-remote-shell-args ("-c")) (tramp-copy-program "nc") @@ -247,24 +255,25 @@ The string is used in `tramp-methods'.") ;; We use "-p" as required for newer busyboxes. For older ;; busybox/nc versions, the value must be (("-l") ("%r")). This ;; can be achieved by tweaking `tramp-connection-properties'. - (tramp-remote-copy-args (("-l") ("-p" "%r") ("2>/dev/null"))))) + (tramp-remote-copy-args (("-l") ("-p" "%r") + ("2>/dev/null"))))) (add-to-list 'tramp-methods - '("su" + `("su" (tramp-login-program "su") (tramp-login-args (("-") ("%u"))) - (tramp-remote-shell "/bin/sh") + (tramp-remote-shell ,tramp-default-remote-shell) (tramp-remote-shell-login ("-l")) (tramp-remote-shell-args ("-c")) (tramp-connection-timeout 10))) (add-to-list 'tramp-methods - '("sg" + `("sg" (tramp-login-program "sg") (tramp-login-args (("-") ("%u"))) - (tramp-remote-shell "/bin/sh") + (tramp-remote-shell ,tramp-default-remote-shell) (tramp-remote-shell-args ("-c")) (tramp-connection-timeout 10))) (add-to-list 'tramp-methods - '("sudo" + `("sudo" (tramp-login-program "sudo") ;; The password template must be masked. Otherwise, ;; it could be interpreted as password prompt if the @@ -273,46 +282,47 @@ The string is used in `tramp-methods'.") ("-p" "P\"\"a\"\"s\"\"s\"\"w\"\"o\"\"r\"\"d\"\":"))) ;; Local $SHELL could be a nasty one, like zsh or ;; fish. Let's override it. - (tramp-login-env (("SHELL") ("/bin/sh"))) - (tramp-remote-shell "/bin/sh") + (tramp-login-env (("SHELL") + (,tramp-default-remote-shell))) + (tramp-remote-shell ,tramp-default-remote-shell) (tramp-remote-shell-login ("-l")) (tramp-remote-shell-args ("-c")) (tramp-connection-timeout 10) (tramp-session-timeout 300))) (add-to-list 'tramp-methods - '("doas" + `("doas" (tramp-login-program "doas") (tramp-login-args (("-u" "%u") ("-s"))) - (tramp-remote-shell "/bin/sh") + (tramp-remote-shell ,tramp-default-remote-shell) (tramp-remote-shell-args ("-c")) (tramp-connection-timeout 10) (tramp-session-timeout 300))) (add-to-list 'tramp-methods - '("ksu" + `("ksu" (tramp-login-program "ksu") (tramp-login-args (("%u") ("-q"))) - (tramp-remote-shell "/bin/sh") + (tramp-remote-shell ,tramp-default-remote-shell) (tramp-remote-shell-login ("-l")) (tramp-remote-shell-args ("-c")) (tramp-connection-timeout 10))) (add-to-list 'tramp-methods - '("krlogin" + `("krlogin" (tramp-login-program "krlogin") (tramp-login-args (("%h") ("-l" "%u") ("-x"))) - (tramp-remote-shell "/bin/sh") + (tramp-remote-shell ,tramp-default-remote-shell) (tramp-remote-shell-login ("-l")) (tramp-remote-shell-args ("-c")))) (add-to-list 'tramp-methods `("plink" (tramp-login-program "plink") - (tramp-login-args (("-l" "%u") ("-P" "%p") ("-ssh") ("-t") - ("%h") ("\"") + (tramp-login-args (("-l" "%u") ("-P" "%p") ("-ssh") + ("-t") ("%h") ("\"") (,(format "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'" tramp-terminal-type tramp-initial-end-of-output)) - ("/bin/sh") ("\""))) - (tramp-remote-shell "/bin/sh") + ("%l") ("\""))) + (tramp-remote-shell ,tramp-default-remote-shell) (tramp-remote-shell-login ("-l")) (tramp-remote-shell-args ("-c")))) (add-to-list 'tramp-methods @@ -323,50 +333,50 @@ The string is used in `tramp-methods'.") "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'" tramp-terminal-type tramp-initial-end-of-output)) - ("/bin/sh") ("\""))) - (tramp-remote-shell "/bin/sh") + ("%l") ("\""))) + (tramp-remote-shell ,tramp-default-remote-shell) (tramp-remote-shell-login ("-l")) (tramp-remote-shell-args ("-c")))) (add-to-list 'tramp-methods `("pscp" (tramp-login-program "plink") - (tramp-login-args (("-l" "%u") ("-P" "%p") ("-ssh") ("-t") - ("%h") ("\"") + (tramp-login-args (("-l" "%u") ("-P" "%p") ("-ssh") + ("-t") ("%h") ("\"") (,(format "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'" tramp-terminal-type tramp-initial-end-of-output)) - ("/bin/sh") ("\""))) - (tramp-remote-shell "/bin/sh") + ("%l") ("\""))) + (tramp-remote-shell ,tramp-default-remote-shell) (tramp-remote-shell-login ("-l")) (tramp-remote-shell-args ("-c")) (tramp-copy-program "pscp") - (tramp-copy-args (("-l" "%u") ("-P" "%p") ("-scp") ("-p" "%k") - ("-q") ("-r"))) + (tramp-copy-args (("-l" "%u") ("-P" "%p") ("-scp") + ("-p" "%k") ("-q") ("-r"))) (tramp-copy-keep-date t) (tramp-copy-recursive t))) (add-to-list 'tramp-methods `("psftp" (tramp-login-program "plink") - (tramp-login-args (("-l" "%u") ("-P" "%p") ("-ssh") ("-t") - ("%h") ("\"") + (tramp-login-args (("-l" "%u") ("-P" "%p") ("-ssh") + ("-t") ("%h") ("\"") (,(format "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'" tramp-terminal-type tramp-initial-end-of-output)) - ("/bin/sh") ("\""))) - (tramp-remote-shell "/bin/sh") + ("%l") ("\""))) + (tramp-remote-shell ,tramp-default-remote-shell) (tramp-remote-shell-login ("-l")) (tramp-remote-shell-args ("-c")) (tramp-copy-program "pscp") - (tramp-copy-args (("-l" "%u") ("-P" "%p") ("-sftp") ("-p" "%k") - ("-q"))) + (tramp-copy-args (("-l" "%u") ("-P" "%p") ("-sftp") + ("-p" "%k") ("-q"))) (tramp-copy-keep-date t))) (add-to-list 'tramp-methods - '("fcp" + `("fcp" (tramp-login-program "fsh") (tramp-login-args (("%h") ("-l" "%u") ("sh" "-i"))) - (tramp-remote-shell "/bin/sh") + (tramp-remote-shell ,tramp-default-remote-shell) (tramp-remote-shell-login ("-l")) (tramp-remote-shell-args ("-i") ("-c")) (tramp-copy-program "fcp") @@ -778,7 +788,8 @@ my $data; while (read STDIN, $data, 54) { my $pad = q(); - # Only for the last chunk, and only if did not fill the last three-byte packet + # Only for the last chunk, and only if did not fill the last + # three-byte packet if (eof) { my $mod = length($data) %% 3; $pad = q(=) x (3 - $mod) if $mod; @@ -4023,19 +4034,22 @@ file exists and nonzero exit status otherwise." vec 'file-error "Couldn't find command to check if file exists")) result)) +(defun tramp-get-sh-extra-args (shell) + "Find extra args for SHELL." + (let ((alist tramp-sh-extra-args) + item extra-args) + (while (and alist (null extra-args)) + (setq item (pop alist)) + (when (string-match-p (car item) shell) + (setq extra-args (cdr item)))) + extra-args)) + (defun tramp-open-shell (vec shell) "Opens shell SHELL." (with-tramp-progress-reporter vec 5 (format-message "Opening remote shell `%s'" shell) ;; Find arguments for this shell. - (let ((alist tramp-sh-extra-args) - item extra-args) - (while (and alist (null extra-args)) - (setq item (pop alist)) - (when (string-match-p (car item) shell) - (setq extra-args (cdr item)))) - ;; It is useful to set the prompt in the following command - ;; because some people have a setting for $PS1 which /bin/sh + (let ((extra-args (tramp-get-sh-extra-args shell))) ;; doesn't know about and thus /bin/sh will display a strange ;; prompt. For example, if $PS1 has "${CWD}" in the value, then ;; ksh will display the current working directory but /bin/sh @@ -4894,6 +4908,9 @@ connection if a previous connection has died for some reason." (tramp-get-method-parameter hop 'tramp-login-program)) (login-args (tramp-get-method-parameter hop 'tramp-login-args)) + (remote-shell + (tramp-get-method-parameter hop 'tramp-remote-shell)) + (extra-args (tramp-get-sh-extra-args remote-shell)) (login-env (tramp-get-method-parameter hop 'tramp-login-env)) (async-args @@ -4971,7 +4988,8 @@ connection if a previous connection has died for some reason." spec (format-spec-make ?t tmpfile) options (format-spec options spec) spec (format-spec-make - ?h l-host ?u l-user ?p l-port ?c options) + ?h l-host ?u l-user ?p l-port ?c options + ?l (concat remote-shell " " extra-args)) command (concat ;; We do not want to see the trailing local @@ -5320,7 +5338,7 @@ Nonexistent directories are removed from spec." (progn (tramp-message vec 3 - "`getconf PATH' not successful, using default value \"%s\"." + "`getconf PATH' not successful, using default value \"%s\"." "/bin:/usr/bin") "/bin:/usr/bin")))) (own-remote-path @@ -5894,9 +5912,6 @@ function cell is returned to be applied on a buffer." ;; way of passing credentials, like by using an SSL socket or ;; something. (David Kastrup) ;; -;; * Reconnect directly to a compliant shell without first going -;; through the user's default shell. (Pete Forman) -;; ;; * Avoid the local shell entirely for starting remote processes. If ;; so, I think even a signal, when delivered directly to the local ;; SSH instance, would correctly be propagated to the remote process diff --git a/lisp/net/tramp.el b/lisp/net/tramp.el index aefb84bb4e..934b5dd9d9 100644 --- a/lisp/net/tramp.el +++ b/lisp/net/tramp.el @@ -212,22 +212,32 @@ pair of the form (KEY VALUE). The following KEYs are defined: * `tramp-login-args' This specifies the list of arguments to pass to the above - mentioned program. Please note that this is a list of list of arguments, - that is, normally you don't want to put \"-a -b\" or \"-f foo\" - here. Instead, you want a list (\"-a\" \"-b\"), or (\"-f\" \"foo\"). - There are some patterns: \"%h\" in this list is replaced by the host - name, \"%u\" is replaced by the user name, \"%p\" is replaced by the - port number, and \"%%\" can be used to obtain a literal percent character. - If a list containing \"%h\", \"%u\" or \"%p\" is unchanged during - expansion (i.e. no host or no user specified), this list is not used as - argument. By this, arguments like (\"-l\" \"%u\") are optional. - \"%t\" is replaced by the temporary file name produced with - `tramp-make-tramp-temp-file'. \"%k\" indicates the keep-date - parameter of a program, if exists. \"%c\" adds additional - `tramp-ssh-controlmaster-options' options for the first hop. - The existence of `tramp-login-args', combined with the absence of - `tramp-copy-args', is an indication that the method is capable of - multi-hops. + mentioned program. Please note that this is a list of list + of arguments, that is, normally you don't want to put \"-a + -b\" or \"-f foo\" here. Instead, you want a list (\"-a\" + \"-b\"), or (\"-f\" \"foo\"). There are some patterns: + + - \"%h\" in this list is replaced by the host name + - \"%u\" is replaced by the user name + - \"%p\" is replaced by the port number + - \"%%\" can be used to obtain a literal percent character. + + If a list containing \"%h\", \"%u\" or \"%p\" is unchanged + during expansion (i.e. no host, no user or no port + specified), this list is not used as argument. By this, + arguments like (\"-l\" \"%u\") are optional. + + - \"%l\" is replaced by the login shell `tramp-remote-shell' + and its parameters. + - \"%t\" is replaced by the temporary file name produced with + `tramp-make-tramp-temp-file'. + - \"%k\" indicates the keep-date parameter of a program, if exists + - \"%c\" adds additional `tramp-ssh-controlmaster-options' + options for the first hop. + + The existence of `tramp-login-args', combined with the + absence of `tramp-copy-args', is an indication that the + method is capable of multi-hops. * `tramp-login-env' A list of environment variables and their values, which will @@ -327,6 +337,9 @@ inline method, then these two parameters should be nil. Notes: +All these arguments can be overwritten by connection properties. +See Info node `(tramp) Predefined connection information'. + When using `su' or `sudo' the phrase \"open connection to a remote host\" sounds strange, but it is used nevertheless, for consistency. No connection is opened to a remote host, but `su' or `sudo' is