Merge from savannah/emacs-30

dce31372a6 editorconfig-core-handle.el: Fix regressions in fnmatch h...
ed2986494c Checkdoc fixes in `url/*.el`
846c0e10ff Checkdoc fixes in `term/*.el`
3977aa0756 Checkdoc fixes in `mh-e/*.el`
521f740d01 Checkdoc fixes in `calc/*.el`
336aa6ab17 Checkdoc fixes in `textmodes/*.el`
e19fd6a22d Checkdoc fixes in `gnus/*.el`
7350457c79 Checkdoc fixes in `eshell/*.el`
23c1ba81dd Checkdoc fixes in `emulation/*.el`
c85f67a66d Checkdoc fixes in `erc/*.el`
e392382e2e Checkdoc fixes in `vc/*.el`
ef7364b070 Checkdoc fixes in `emacs-lisp/*.el`
5fe1ae0e84 Checkdoc fixes in `mail/*.el`
e43e9d0998 Checkdoc fixes in `net/*.el`
4c6e9f5b00 Improve `use-package-vc-valid-keywords` docstring format
928180f32b ; * etc/TODO: New item on installing Magit.
c193a702dc ; Improve a recent change to the documentation
6ebc5d5c27 ; Delete fixed item from etc/TODO: "proced on macOS"
7b2778e3a3 ; Delete fixed NS bug from etc/TODO
84552ff395 Revert "Fix link to major mode variable in docstring"
198063ba64 * etc/TODO: Add item to convert documentation to 'setopt'.
92de67829c Prefer 'setopt' in browse-url docs
7668385390 ; Improve 'native-comp-debug' documentation

doc/lispref/compile.texi

@@ -1024,6 +1024,9 @@ Like 1, and in addition dump pseudo-C code.
 Like 2, and in addition dump the GCC intermediate passes and
 @file{libgccjit} log file.
 @end table
+
+When generated, the pseudo-C code is deposited in the same directory
+as the corresponding @file{.eln} file.
 @end defopt
 
 @defopt native-comp-verbose

etc/TODO

@@ -88,6 +88,15 @@ outside of the mode they were written for.
 Verify the conversion by comparing the value of the keymap before
 converting it and after (you can see the value in 'C-h v').
 
+** Change documentation examples to use 'setopt' instead of 'setq'
+User options are variables defined with 'defcustom', as opposed to
+'defvar' or 'defconst'.  It is preferable to use 'setopt' to set user
+options instead of 'setq', since it will execute any ‘custom-set’ form
+associated with that variable.  Pick a package and make sure that it
+uses 'setopt' in any examples in its documentation (doc strings, manual,
+Commentary section, etc.).  Note that 'setopt' is new in Emacs 29.1, so
+packages that need support for earlier versions should still use 'setq'.
+
 ** Write more tests
 Pick a fixed bug from the database, write a test case to make sure it
 stays fixed.  Or pick your favorite programming major-mode, and write
@@ -718,10 +727,17 @@ bar.  In the mean time, it should process other messages.
 
 ** Get some major packages installed
 
+*** Magit
+This needs work on getting the relevant copyright assignments.  This
+task should be highly doable for anyone, but will likely require some
+patience.  For inspiration, see how this was done for 'use-package':
+https://github.com/jwiegley/use-package/issues/282
+
 *** PSGML, _possibly_ ECB
 https://lists.gnu.org/r/emacs-devel/2007-05/msg01493.html Check the
 assignments file for other packages which might go in and have been
-missed.
+missed.  (Not sure if this is still relevant in 2024.  For example, both
+packages seem to be unmaintained.)
 
 ** Make byte-compiler warnings smarter
 Byte-compiler warnings about functions that might be undefined at run
@@ -944,25 +960,6 @@ the tool bar is performed.
 Unfortunately, the tool bar (and possible other operations) always
 resize the frame.
 
-**** Support 'proced' (implement 'process-attributes')
-Unfortunately, a user-level process like Emacs does not have the
-privileges to get information about other processes under macOS.
-
-There are other ways to do this:
-
- 1) Spawn "ps" and parse the output ("ps" has superuser privileges).
-
- 2) Sign Emacs as part of the distribution process.
-
- 3) Ask the user to self-sign Emacs, if this feature is of interest.
-
-Anders Lindgren <andlind@gmail.com> has implemented
-'process-attributes' for macOS, which currently only work when
-running Emacs as root.
-
-See this article by Bozhidar Batsov for an overview of Proced:
-https://emacsredux.com/blog/2013/05/02/manage-processes-with-proced/
-
 **** Tooltip properties
 Tooltip properties like the background color and font are hard-wired,
 even though Emacs allows a user to customize such features.
@@ -1104,10 +1101,6 @@ corner and track mouse movements, but this did not work well, and was
 not scalable to the new Lion "resize on every window edge" behavior.
 [As of trunk r109635, 2012-08-15, the event loop no longer polls.]
 
-**** mouse-avoidance-mode
-(mouse-avoidance-mode 'banish) then minimize Emacs, will pop window back
-up on top of all others (probably fixed in bug#17439).
-
 **** free_frame_resources, face colors
 
 **** Numeric keysetting bug.

lisp/calc/calc.el

@@ -341,7 +341,7 @@ See calc-embedded-open-plain."
 
 (defcustom calc-embedded-open-close-new-formula-alist
   nil
-  "Alist of major modes with pairs of new formula delimiters used by calc-embedded."
+  "Alist of major modes with pairs of new formula delimiters used by `calc-embedded'."
   :type '(alist :key-type (symbol :tag "Major mode")
                 :value-type (list (string :tag "Opening new formula delimiter")
                                   (string :tag "Closing new formula delimiter"))))

lisp/editorconfig-core-handle.el

@@ -127,9 +127,9 @@ If HANDLE is nil return nil."
 
 If HANDLE is nil return nil."
   (when handle
-    (let ((hash (make-hash-table))
-          (file (file-relative-name file (editorconfig-core-handle-path
-                                          handle))))
+    (let* ((hash (make-hash-table))
+           (dir (file-name-directory (editorconfig-core-handle-path handle)))
+           (file (file-relative-name file dir)))
       (dolist (section (editorconfig-core-handle-sections handle))
         (cl-loop for (key . value) in (editorconfig-core-handle-section-get-properties section file)
                  do (puthash (intern key) value hash)))
@@ -143,7 +143,11 @@ This function is a fnmatch with a few modification for EditorConfig usage."
   (if (string-match-p "/" pattern)
       (let ((pattern (replace-regexp-in-string "\\`/" "" pattern)))
         (editorconfig-fnmatch-p name pattern))
-    (editorconfig-fnmatch-p (file-name-nondirectory name) pattern)))
+    ;; The match is not "anchored" so it can be either in the current dir or
+    ;; in a subdir.  Contrary to Zsh patterns, editorconfig's `**/foo' does
+    ;; not match `foo', so we need to split the problem into two matches.
+    (or (editorconfig-fnmatch-p name pattern)
+        (editorconfig-fnmatch-p name (concat "**/" pattern)))))
 
 (defun editorconfig-core-handle--parse-file (conf)
   "Parse EditorConfig file CONF.

lisp/emacs-lisp/bytecomp.el

@@ -3832,7 +3832,7 @@ This assumes the function has the `important-return-value' property."
 (defun byte-compile-free-vars-warn (arg var &optional assignment)
   "Warn if symbol VAR refers to a free variable.
 VAR must not be lexically bound.
-ARG is a position argument, used by byte-compile-warn-x.
+ARG is a position argument, used by `byte-compile-warn-x'.
 If optional argument ASSIGNMENT is non-nil, this is treated as an
 assignment (i.e. `setq')."
   (unless (or (not (byte-compile-warning-enabled-p 'free-vars var))
@@ -5488,7 +5488,7 @@ OP and OPERAND are as passed to `byte-compile-out'."
 (defun byte-compile-out (op &optional operand)
   "Push the operation onto `byte-compile-output'.
 OP is an opcode, a symbol.  OPERAND is either nil or a number or
-a one-element list of a lisp form."
+a one-element list of a Lisp form."
   (when (and (consp operand) (null (cdr operand)))
     (setq operand (byte-run-strip-symbol-positions operand)))
   (push (cons op operand) byte-compile-output)

lisp/emacs-lisp/comp.el

@@ -75,7 +75,9 @@ This is intended for debugging the compiler itself.
   1 emit debug symbols.
   2 emit debug symbols and dump pseudo C code.
   3 emit debug symbols and dump: pseudo C code, GCC intermediate
-  passes and libgccjit log file."
+  passes and libgccjit log file.
+When generated, the pseudo C code is deposited in the same directory
+as the corresponding .eln file."
   :type 'natnum
   :safe #'natnump
   :version "29.1")

lisp/emacs-lisp/easy-mmode.el

@@ -91,7 +91,7 @@ Enable the mode if ARG is nil, omitted, or is a positive number.
 Disable the mode if ARG is a negative number.
 
 To check whether the minor mode is enabled in the current buffer,
-evaluate the variable `%s'.
+evaluate `%s'.
 
 The mode's hook is called both when the mode is enabled and when
 it is disabled.")

lisp/emacs-lisp/find-func.el

@@ -125,7 +125,7 @@ should insert the feature name."
 
 (defcustom find-ert-deftest-regexp
   "(ert-deftest +'%s"
-  "The regexp used to search for an ert-deftest definition.
+  "The regexp used to search for an `ert-deftest' definition.
 Note it must contain a `%s' at the place where `format'
 should insert the feature name."
   :type 'regexp

lisp/emacs-lisp/macroexp.el

@@ -37,7 +37,7 @@ most deeply nested form.
 Normally a form is manually pushed onto the list at the beginning
 of `byte-compile-form', etc., and manually popped off at its end.
 This is to preserve the data in it in the event of a
-condition-case handling a signaled error.")
+`condition-case' handling a signaled error.")
 
 (defmacro macroexp--with-extended-form-stack (expr &rest body)
   "Evaluate BODY with EXPR pushed onto `byte-compile-form-stack'."

lisp/emulation/viper-mous.el

@@ -456,7 +456,7 @@ bindings in the Viper manual."
 		   (if (eq 'up event-type)
 		       "mouse-3" "down-mouse-3"))
 		  (t (error
-		      "%S: invalid button number, %S" key-var key)))
+                      "%S: Invalid button number, %S" key-var key)))
 	    meta-spec
 	    (if (memq 'meta key) "M-" "")
 	    shift-spec

lisp/emulation/viper.el

@@ -486,7 +486,7 @@ unless it is coming up in a wrong Viper state."
   "List specifying how to modify the various major modes to enable some Viperisms.
 The list has the structure: ((mode viper-state keymap) (mode viper-state
 keymap) ...).  If `mode' is on the list, the `keymap' will be made active (on
-the minor-mode-map-alist) in the specified viper state.
+the `minor-mode-map-alist') in the specified viper state.
 If you change this list, have to restart Emacs for the change to take effect.
 However, if you did the change through the customization widget, then Emacs
 needs to be restarted only if you deleted a triple mode-state-keymap from the

lisp/erc/erc-backend.el

@@ -260,7 +260,7 @@ or
 where PARAMETER is a string and VALUE is a string or nil.  For
 compatibility, a raw parameter of the form \"FOO=\" becomes
 (\"FOO\" . \"\") even though it's equivalent to the preferred
-canonical form \"FOO\" and its lisp representation (\"FOO\").
+canonical form \"FOO\" and its Lisp representation (\"FOO\").
 
 Some examples of possible parameters sent by servers:
 CHANMODES=b,k,l,imnpst - list of supported channel modes

lisp/erc/erc-button.el

@@ -815,7 +815,7 @@ and `apropos' for other symbols."
 
 (defun erc-button--display-error-with-buttons
     (from to fun nick-p &optional data regexp)
-  "Replace command in region with keys and return new bounds"
+  "Replace command in region with keys and return new bounds."
   (let* ((o (buffer-substring from to))
          (s (substitute-command-keys o))
          (erc-button-face (and (equal o s) erc-button-face)))

lisp/erc/erc-dcc.el

@@ -173,7 +173,7 @@ ARGS is a plist.  Return nil on no match.
 
 The property :nick is treated specially, if it contains a `!' character,
 it is treated as a nick!user@host string, and compared with the :nick property
-value of the individual elements using string-equal.  Otherwise it is
+value of the individual elements using `string-equal'.  Otherwise it is
 compared with `erc-nick-equal-p' which is IRC case-insensitive."
   (let ((list erc-dcc-list)
         result test)

lisp/erc/erc-fill.el

@@ -799,7 +799,7 @@ necessary after revealing previously hidden text with commands
 like `erc-match-toggle-hidden-fools'."
   (interactive "P")
   (unless erc-fill-wrap-mode
-    (user-error "Module `fill-wrap' not active in current buffer."))
+    (user-error "Module `fill-wrap' not active in current buffer"))
   (save-excursion
     (with-silent-modifications
       (let* ((rep (make-progress-reporter

lisp/erc/erc-speedbar.el

@@ -548,7 +548,7 @@ associated with an ERC session."
   "Speedbar update period.")
 
 (defvar-local erc-speedbar--last-ran nil
-  "When non-nil, a lisp timestamp updated when the speedbar timer runs.")
+  "When non-nil, a Lisp timestamp updated when the speedbar timer runs.")
 
 (defun erc-speedbar--prod-dframe-timer (&rest _)
   "Refresh speedbar if dormant for `erc-speedbar--force-update-interval-secs'."

lisp/erc/erc-stamp.el

@@ -210,11 +210,11 @@ from entering them and instead jump over them."
 
 (defvar erc-stamp--current-time nil
   "The current time when calling `erc-insert-timestamp-function'.
-Specifically, this is the same lisp time object used to create
+Specifically, this is the same Lisp time object used to create
 the stamp passed to `erc-insert-timestamp-function'.")
 
 (cl-defgeneric erc-stamp--current-time ()
-  "Return a lisp time object to associate with an IRC message.
+  "Return a Lisp time object to associate with an IRC message.
 This becomes the message's `erc--ts' text property."
   (erc-compat--current-lisp-time))
 

lisp/erc/erc.el

@@ -1868,7 +1868,7 @@ the value of this option is DISPLAY-FUNCTION."
   "How to display buffers as a result of user interaction.
 This affects commands like /QUERY and /JOIN when issued
 interactively at the prompt.  It does not apply when calling a
-handler for such a command, like `erc-cmd-JOIN', from lisp code.
+handler for such a command, like `erc-cmd-JOIN', from Lisp code.
 See `erc-buffer-display' for a full description of available
 values.
 
@@ -2269,7 +2269,7 @@ buffer rather than a server buffer.")
                           list match menu move-to-prompt netsplit
                           networks readonly ring stamp track)
   "Modules to enable while connecting.
-When modifying this option in lisp code, use a Custom-friendly
+When modifying this option in Lisp code, use a Custom-friendly
 facilitator, like `setopt', or call `erc-update-modules'
 afterward.  This ensures a consistent ordering and disables
 removed modules.  It also gives packages access to the hook
@@ -4476,7 +4476,7 @@ Called with position indicating boundary of interval to be excised.")
 (defun erc-cmd-CLEAR ()
   "Clear messages in current buffer after informing active modules.
 Expect modules to perform housekeeping tasks to withstand the
-disruption.  When called from lisp code, only clear messages up
+disruption.  When called from Lisp code, only clear messages up
 to but not including the one occupying the current line."
   (with-silent-modifications
     (let ((max (if (>= (point) erc-insert-marker)
@@ -7288,7 +7288,7 @@ status switches among VOICE, HALFOP, OP, ADMIN, and OWNER to be
 the symbol `on' or `off' when needing to influence a new or
 existing `erc-channel-user' object's `status' slot.  Likewise,
 when UPDATE-MESSAGE-TIME is non-nil, update or initialize the
-`last-message-time' slot to the current-time.  If changes occur,
+`last-message-time' slot to the `current-time'.  If changes occur,
 including creation, run `erc-channel-members-changed-hook'.
 Return non-nil when meaningful changes, including creation, have
 occurred.
@@ -9173,7 +9173,7 @@ Currently only used by the option `erc-prompt-format'.")
 ;; As of ERC 5.6, this is identical to the away variant aside from
 ;; the var names and `eq', which isn't important.
 (defun erc--format-user-modes ()
-  "Return server's user modes as a string"
+  "Return server's user modes as a string."
   (and-let* ((indicator (erc-with-server-buffer
                           (or erc--user-modes-indicator
                               (setq erc--user-modes-indicator (list "")))))
@@ -9730,7 +9730,7 @@ or `erc-kill-buffer-hook' if any other buffer."
 (defun erc-check-text-conversion ()
   "Check if point is within the ERC prompt and toggle text conversion.
 If `text-conversion-style' is not `action' if point is within the
-prompt or `nil' otherwise, set it to such a value, so as to
+prompt or nil otherwise, set it to such a value, so as to
 guarantee that the input method functions properly for the
 purpose of typing within the ERC prompt."
   (when (and (eq major-mode 'erc-mode)

lisp/eshell/em-elecslash.el

@@ -108,4 +108,4 @@ insertion."
         (insert "/")))))
 
 (provide 'em-elecslash)
-;;; esh-elecslash.el ends here
+;;; em-elecslash.el ends here

lisp/eshell/em-extpipe.el

@@ -217,4 +217,4 @@ as though it were Eshell syntax."
   (error "Unhandled external pipeline in input text"))
 
 (provide 'em-extpipe)
-;;; esh-extpipe.el ends here
+;;; em-extpipe.el ends here

lisp/eshell/esh-cmd.el

@@ -154,8 +154,7 @@ To prevent a command from executing at all, set
   :type 'hook)
 
 (defcustom eshell-named-command-hook nil
-  "A set of functions called before
-a named command is invoked.
+  "A set of functions called before a named command is invoked.
 Each function will be passed the command name and arguments that were
 passed to `eshell-named-command'.
 
@@ -816,7 +815,7 @@ current ones (see `eshell-duplicate-handles')."
 This changes COMMAND in-place by converting function calls listed
 in `eshell-deferrable-commands' to their non-deferrable forms so
 that Eshell doesn't erroneously allow deferring it.  For example,
-`eshell-named-command' becomes `eshell-named-command*', "
+`eshell-named-command' becomes `eshell-named-command*'."
   (let ((cmd command))
     (when (memq (car cmd) '(let progn))
       (setq cmd (car (last cmd))))

lisp/eshell/esh-module.el

@@ -99,7 +99,7 @@ extension module; if nil, KIND defaults to `extension'."
   (let ((module-name (symbol-name module))
         (prefix (cond ((eq kind 'core) "esh-")
                       ((memq kind '(extension nil)) "em-")
-                      (t (error "unknown module kind %s" kind)))))
+                      (t (error "Unknown module kind %s" kind)))))
     (if (string-match "^eshell-\\(.*\\)" module-name)
 	(concat prefix (match-string 1 module-name))
       (error "Invalid Eshell module name: %s" module))))

lisp/gnus/gnus-agent.el

@@ -153,7 +153,7 @@ this limit."
 When set to ENABLE, the default, `gnus-agent-expire' will expire old
 contents from a group's local storage.  This value may be overridden
 to disable expiration in specific categories, topics, and groups.  Of
-course, you could change gnus-agent-enable-expiration to DISABLE then
+course, you could change `gnus-agent-enable-expiration' to DISABLE then
 enable expiration per categories, topics, and groups."
   :version "22.1"
   :group 'gnus-agent
@@ -275,8 +275,8 @@ Actually a hash table holding subjects mapped to t.")
 ;;;
 
 (defmacro gnus-agent-with-refreshed-group (group &rest body)
-  "Performs the body then updates the group's line in the group
-buffer.  Automatically blocks multiple updates due to recursion."
+  "Perform the body then update the group's line in the group buffer.
+Automatically block multiple updates due to recursion."
   `(prog1 (let ((gnus-agent-inhibit-update-total-fetched-for t)) ,@body)
      (when (and gnus-agent-need-update-total-fetched-for
 		(not gnus-agent-inhibit-update-total-fetched-for))
@@ -618,8 +618,8 @@ manipulated as follows:
 (defun gnus-agentize ()
   "Allow Gnus to be an offline newsreader.
 
-The gnus-agentize function is now called internally by gnus when
-gnus-agent is set.  If you wish to avoid calling gnus-agentize,
+The `gnus-agentize' function is now called internally by gnus when
+`gnus-agent' is set.  If you wish to avoid calling `gnus-agentize',
 customize `gnus-agent' to nil.
 
 This will modify the `gnus-setup-news-hook', and
@@ -1785,9 +1785,9 @@ variables.  Returns the first non-nil value found."
                 (agent-predicate . gnus-agent-predicate)))))))
 
 (defun gnus-agent-fetch-headers (group)
-  "Fetch interesting headers into the agent.  The group's overview
-file will be updated to include the headers while a list of available
-article numbers will be returned."
+  "Fetch interesting headers into the agent.
+The group's overview file will be updated to include the headers while a
+list of available article numbers will be returned."
   (let* ((fetch-all (and gnus-agent-consider-all-articles
                          ;; Do not fetch all headers if the predicate
                          ;; implies that we only consider unread articles.
@@ -4059,8 +4059,7 @@ CLEAN is obsolete and ignored."
 
 (defun gnus-agent-update-files-total-fetched-for (group delta
 							&optional method path)
-  "Update, or set, the total disk space used by the articles that the
-agent has fetched."
+  "Update or set total disk space used by articles that the agent has fetched."
   (when gnus-agent-total-fetched-hashtb
     (gnus-agent-with-refreshed-group
      group
@@ -4099,9 +4098,8 @@ agent has fetched."
 
 (defun gnus-agent-update-view-total-fetched-for
     (group agent-over &optional method path)
-  "Update, or set, the total disk space used by the .agentview and
-.overview files.  These files are calculated separately as they can be
-modified."
+  "Update or set the total disk space used by the .agentview and .overview files.
+These files are calculated separately as they can be modified."
   (when gnus-agent-total-fetched-hashtb
     (gnus-agent-with-refreshed-group
      group

lisp/gnus/gnus-art.el

@@ -330,8 +330,7 @@ to match a mail address in the From: header, BANNER is one of a symbol
 If ADDRESS matches author's mail address, it will remove things like
 advertisements.  For example:
 
-\((\"@yoo-hoo\\\\.co\\\\.jp\\\\\\='\" . \"\\n_+\\nDo You Yoo-hoo!\\\\?\\n.*\\n.*\\n\"))
-"
+\((\"@yoo-hoo\\\\.co\\\\.jp\\\\\\='\" . \"\\n_+\\nDo You Yoo-hoo!\\\\?\\n.*\\n.*\\n\"))"
   :type '(repeat
 	  (cons
 	   (regexp :tag "Address")
@@ -557,15 +556,15 @@ command, and friends such as `gnus-summary-save-article-rmail'.
 
 Gnus provides the following functions:
 
-* gnus-summary-save-in-rmail (Rmail format)
-* gnus-summary-save-in-mail (Unix mail format)
-* gnus-summary-save-in-folder (MH folder)
-* gnus-summary-save-in-file (article format)
-* gnus-summary-save-body-in-file (article body)
-* gnus-summary-save-in-vm (use VM's folder format)
-* gnus-summary-write-to-file (article format -- overwrite)
-* gnus-summary-write-body-to-file (article body -- overwrite)
-* gnus-summary-save-in-pipe (article format)
+* `gnus-summary-save-in-rmail' (Rmail format)
+* `gnus-summary-save-in-mail' (Unix mail format)
+* `gnus-summary-save-in-folder' (MH folder)
+* `gnus-summary-save-in-file' (article format)
+* `gnus-summary-save-body-in-file' (article body)
+* `gnus-summary-save-in-vm' (use VM's folder format)
+* `gnus-summary-write-to-file' (article format -- overwrite)
+* `gnus-summary-write-body-to-file' (article body -- overwrite)
+* `gnus-summary-save-in-pipe' (article format)
 
 The symbol of each function may have the following properties:
 
@@ -5519,8 +5518,7 @@ CHARSET may either be a string or a symbol."
 	(setcdr type (cons (cons 'charset charset) (cdr type)))))))
 
 (defun gnus-mime-view-part-as-charset (&optional handle arg event)
-  "Insert the MIME part under point into the current buffer using the
-specified charset."
+  "Insert MIME part under point into current buffer using specified charset."
   (interactive (list nil current-prefix-arg last-nonmenu-event)
 	       gnus-article-mode)
   (save-excursion
@@ -7304,8 +7302,7 @@ If given a prefix, show the hidden text instead."
 			    (point)))))))
 
 (defun gnus-block-private-groups (group)
-  "Allows images in newsgroups to be shown, blocks images in all
-other groups."
+  "Allows images in newsgroups to be shown, blocks images in all other groups."
   (if (or (gnus-news-group-p group)
 	  (gnus-member-of-valid 'global group)
 	  (member group gnus-global-groups))
@@ -7389,7 +7386,7 @@ other groups."
 
 (define-derived-mode gnus-article-edit-mode message-mode "Article Edit"
   "Major mode for editing articles.
-This is an extended text-mode.
+This is an extended `text-mode'.
 
 \\{gnus-article-edit-mode-map}"
   (make-local-variable 'gnus-article-edit-done-function)

lisp/gnus/gnus-dired.el

@@ -24,15 +24,15 @@
 ;;; Commentary:
 
 ;; This package provides utility functions for intersections of gnus
-;; and dired.  To enable the gnus-dired-mode minor mode which will
+;; and Dired.  To enable the gnus-dired-mode minor mode which will
 ;; have the effect of installing keybindings in dired-mode, place the
 ;; following in your ~/.gnus:
 
 ;; (require 'gnus-dired) ;, isn't needed due to autoload cookies
 ;; (add-hook 'dired-mode-hook #'turn-on-gnus-dired-mode)
 
-;; Note that if you visit dired buffers before your ~/.gnus file has
-;; been read, those dired buffers won't have the keybindings in
+;; Note that if you visit Dired buffers before your ~/.gnus file has
+;; been read, those Dired buffers won't have the keybindings in
 ;; effect.  To get around that problem, you may want to add the above
 ;; statements to your ~/.emacs instead.
 
@@ -81,7 +81,7 @@ See `mail-user-agent' for more information."
 		(function :tag "Other")))
 
 (define-minor-mode gnus-dired-mode
-  "Minor mode for intersections of gnus and dired.
+  "Minor mode for intersections of gnus and Dired.
 
 \\{gnus-dired-mode-map}"
   :keymap gnus-dired-mode-map
@@ -119,7 +119,7 @@ See `mail-user-agent' for more information."
 
 ;; Method to attach files to a mail composition.
 (defun gnus-dired-attach (files-to-attach)
-  "Attach dired's marked files to a gnus message composition.
+  "Attach Dired's marked files to a gnus message composition.
 If called non-interactively, FILES-TO-ATTACH should be a list of
 filenames."
   (interactive
@@ -180,7 +180,7 @@ filenames."
 (autoload 'mailcap-parse-mailcaps "mailcap" "" t)
 
 (defun gnus-dired-find-file-mailcap (&optional file-name arg)
-  "In dired, visit FILE-NAME according to the mailcap file.
+  "In Dired, visit FILE-NAME according to the mailcap file.
 If ARG is non-nil, open it in a new buffer."
   (interactive (list
 		(file-name-sans-versions (dired-get-filename) t)
@@ -215,7 +215,7 @@ If ARG is non-nil, open it in a new buffer."
               "File no longer exists; type \\`g' to update Dired buffer")))))
 
 (defun gnus-dired-print (&optional file-name print-to)
-  "In dired, print FILE-NAME according to the mailcap file.
+  "In Dired, print FILE-NAME according to the mailcap file.
 
 If there is no print command, print in a PostScript image.  If the
 optional argument PRINT-TO is nil, send the image to the printer.

lisp/gnus/gnus-msg.el

@@ -1918,7 +1918,7 @@ can be attached to them.  If not, a new Message buffer is
 created.
 
 This command uses the process/prefix convention, so if you
-process-mark several articles, they will all be attached."
+`process-mark' several articles, they will all be attached."
   (interactive "P" gnus-summary-mode)
   (let ((buffers (message-buffers))
 	destination)

lisp/gnus/gnus-score.el

@@ -190,7 +190,7 @@ It can be:
    * `(regexp file-name ...)'
      If the `regexp' matches the group name, the first `file-name'
      will be used as the home score file.  (Multiple filenames are
-     allowed so that one may use gnus-score-file-single-match-alist to
+     allowed so that one may use `gnus-score-file-single-match-alist' to
      set this variable.)
 
    * A function.

lisp/gnus/gnus-search.el

@@ -135,8 +135,7 @@ transformed."
   'gnus-search-ignored-newsgroups "28.1")
 
 (defcustom gnus-search-ignored-newsgroups ""
-  "A regexp to match newsgroups in the active file that should
-be skipped when searching."
+  "Regexp matching newsgroups in the active file to skip when searching."
   :version "24.1"
   :type 'regexp)
 
@@ -2186,7 +2185,7 @@ remaining string, then adds all that to the top-level spec."
 
 (defun gnus-search-thread (header &optional group server)
   "Find articles in the thread containing HEADER from GROUP on SERVER.
-If gnus-refer-thread-use-search is nil only the current group is
+If `gnus-refer-thread-use-search' is nil only the current group is
 checked for articles; if t all groups on the server containing
 the article's group will be searched; if a list then all servers
 in this list will be searched.  If possible the newly found

lisp/gnus/gnus-sieve.el

@@ -133,8 +133,7 @@ Return nil if no rule could be guessed."
 
 For example:
 \(gnus-sieve-string-list \\='(\"to\" \"cc\"))
-  => \"[\\\"to\\\", \\\"cc\\\"]\"
-"
+  => \"[\\\"to\\\", \\\"cc\\\"]\""
   (concat "[\"" (mapconcat #'identity list "\", \"") "\"]"))
 
 (defun gnus-sieve-test-list (list)

lisp/gnus/message.el

@@ -6605,8 +6605,7 @@ they are."
   (sit-for 0))
 
 (defcustom message-beginning-of-line t
-  "Whether \\<message-mode-map>\\[message-beginning-of-line]\
- goes to beginning of header values."
+  "Whether \\<message-mode-map>\\[message-beginning-of-line] goes to beginning of header values."
   :version "22.1"
   :group 'message-buffers
   :link '(custom-manual "(message)Movement")
@@ -6668,7 +6667,7 @@ beginning of line.
 When called without a prefix argument, header value spanning
 multiple lines is treated as a single line.  Otherwise, even if
 N is 1, when point is on a continuation header line, it will be
-moved to the beginning "
+moved to the beginning."
   (interactive "^p" message-mode)
   (cond
    ;; Go to beginning of header or beginning of line.

lisp/gnus/mm-view.el

@@ -108,14 +108,14 @@ This is only used if `mm-inline-large-images' is set to
 	 (delete-region b (+ b 2)))))))
 
 (defvar mm-w3m-setup nil
-  "Whether gnus-article-mode has been setup to use emacs-w3m.")
+  "Whether `gnus-article-mode' has been setup to use emacs-w3m.")
 
 ;; External.
 (declare-function w3m-detect-meta-charset "ext:w3m" ())
 (declare-function w3m-region "ext:w3m" (start end &optional url charset))
 
 (defun mm-setup-w3m ()
-  "Setup gnus-article-mode to use emacs-w3m."
+  "Setup `gnus-article-mode' to use emacs-w3m."
   (unless mm-w3m-setup
     (require 'w3m)
     (unless (assq 'gnus-article-mode w3m-cid-retrieve-function-alist)

lisp/gnus/mml-sec.el

@@ -151,9 +151,10 @@ you use Bcc headers to encrypt e-mails to yourself."
 ;;; Configuration/helper functions
 
 (defun mml-signencrypt-style (method &optional style)
-  "Function for setting/getting the signencrypt-style used.  Takes two
-arguments, the method (e.g. \"pgp\") and optionally the mode
-\(e.g. combined).  If the mode is omitted, the current value is returned.
+  "Function for setting/getting the signencrypt-style used.
+Takes two arguments, the method (e.g. \"pgp\") and optionally the mode
+\(e.g. combined).  If the mode is omitted, the current value is
+returned.
 
 For example, if you prefer to use combined sign & encrypt with
 smime, putting the following in your Gnus startup file will

lisp/gnus/nnimap.el

@@ -51,7 +51,7 @@
 
 (defvoo nnimap-server-port nil
   "The IMAP port used.
-If nnimap-stream is `ssl', this will default to `imaps'.  If not,
+If `nnimap-stream' is `ssl', this will default to `imaps'.  If not,
 it will default to `imap'.")
 
 (defvoo nnimap-use-namespaces nil

lisp/gnus/nnmail.el

@@ -602,7 +602,7 @@ These will be logged to the \"*nnmail split*\" buffer."
 
 (defvar nnmail-incoming-coding-system
   mm-text-coding-system
-  "Coding system used in reading inbox")
+  "Coding system used in reading inbox.")
 
 (defcustom nnmail-pathname-coding-system nil
   "Coding system for file name."
@@ -1306,7 +1306,7 @@ See `nnmail-ignore-broken-references'."
   :type 'regexp)
 
 (defun nnmail-ignore-broken-references ()
-  "Ignore the References line and use In-Reply-To
+  "Ignore the References line and use In-Reply-To.
 
 Eudora has a broken References line, but an OK In-Reply-To."
   (goto-char (point-min))

lisp/gnus/nnmairix.el

@@ -368,8 +368,9 @@ wrong count of total articles shown by Gnus.")
 its maildir mail folders (e.g. the Dovecot IMAP server or mutt).")
 
 (defvoo nnmairix-default-group nil
-  "Default search group.  This is the group which is used for all
-temporary searches, e.g. nnmairix-search.")
+  "Default search group.
+This is the group which is used for all temporary searches,
+e.g. nnmairix-search.")
 
 ;;; === Internal variables
 

lisp/gnus/nntp.el

@@ -300,9 +300,10 @@ backend doesn't catch this error.")
 (defvar nntp--report-1 nil)
 
 (defun nntp-report (&rest args)
-  "Report an error from the nntp backend.  The first string in ARGS
-can be a format string.  For some commands, the failed command may be
-retried once before actually displaying the error report."
+  "Report an error from the nntp backend.
+The first string in ARGS can be a format string.  For some commands, the
+failed command may be retried once before actually displaying the error
+report."
   (if nntp--report-1
       (progn
         ;; Throw out to nntp-with-open-group-error so that the connection may

lisp/gnus/nnvirtual.el

@@ -436,7 +436,8 @@ lines have the correct component server prefix."
 (defun nnvirtual-update-read-and-marked (read-p update-p)
   "Copy marks from the virtual group to the component groups.
 If READ-P is not nil, update the (un)read status of the components.
-If UPDATE-P is not nil, call gnus-group-update-group on the components."
+If UPDATE-P is not nil, call `gnus-group-update-group' on the
+components."
   (when nnvirtual-current-group
     (let ((unreads (and read-p
 			(nnvirtual-partition-sequence
@@ -642,7 +643,7 @@ then it is left out of the result."
 
 (defun nnvirtual-partition-sequence (articles)
   "Return an association list of component article numbers.
-These are indexed by elements of nnvirtual-component-groups, based on
+These are indexed by elements of `nnvirtual-component-groups', based on
 the sequence ARTICLES of virtual article numbers.  ARTICLES should be
 sorted, and can be a compressed sequence.  If any of the article
 numbers has no corresponding component article, then it is left out of

lisp/gnus/spam-stat.el

@@ -183,7 +183,7 @@ say, `with-spam-stat-max-buffer-size'."
   :type '(repeat sexp))
 
 (defcustom spam-stat-process-directory-age 90
-  "Max. age of files to be processed in directory, in days.
+  "Maximum age of files to be processed in directory, in days.
 When using `spam-stat-process-spam-directory' or
 `spam-stat-process-non-spam-directory', only files that have
 been touched in this many days will be considered.  Without
@@ -192,7 +192,7 @@ will start to take a very long time."
   :type 'integer)
 
 (defvar spam-stat-last-saved-at nil
-  "Time stamp of last change of spam-stat-file on this run")
+  "Time stamp of last change of `spam-stat-file' on this run.")
 
 (defvar spam-stat-syntax-table
   (let ((table (copy-syntax-table text-mode-syntax-table)))
@@ -394,7 +394,7 @@ Use `spam-stat-ngood', `spam-stat-nbad', `spam-stat-good',
 ;; Saving and Loading
 
 (defun spam-stat-save (&optional force)
-  "Save the `spam-stat' hash table as lisp file.
+  "Save the `spam-stat' hash table as Lisp file.
 With a prefix argument save unconditionally."
   (interactive "P")
   (when (or force spam-stat-dirty)

lisp/gnus/spam.el

@@ -2053,7 +2053,7 @@ See the Info node `(gnus)Fancy Mail Splitting' for more details."
   (add-hook 'bbdb-change-hook #'spam-clear-cache-BBDB))
 
 (defun spam-enter-ham-BBDB (addresses &optional remove)
-  "Enter an address into the BBDB; implies ham (non-spam) sender"
+  "Enter an address into the BBDB; implies ham (non-spam) sender."
   (dolist (from addresses)
     (when (stringp from)
       (let* ((parsed-address (gnus-extract-address-components from))
@@ -2091,7 +2091,7 @@ See the Info node `(gnus)Fancy Mail Splitting' for more details."
     (bbdb-gethash (downcase net))))
 
 (defun spam-check-BBDB ()
-  "Mail from people in the BBDB is classified as ham or non-spam"
+  "Mail from people in the BBDB is classified as ham or non-spam."
   (let ((net (message-fetch-field "from")))
     (when net
       (setq net (nth 1 (gnus-extract-address-components net)))

lisp/mail/feedmail.el

@@ -1318,7 +1318,7 @@ Then add the functions you want called to either
 `feedmail-mail-send-hook-queued' or `feedmail-mail-send-hook', as
 appropriate.  The distinction is that `feedmail-mail-send-hook'
 will be called when you send mail from a composition
-buffer (typically by typing C-c C-c), whether the message is sent
+buffer (typically by typing \\`C-c C-c'), whether the message is sent
 immediately or placed in the queue or drafts directory.
 `feedmail-mail-send-hook-queued' is called when messages are
 being sent from the queue directory, typically via a call to
@@ -1443,10 +1443,11 @@ Called for each message read back out of the queue directory with a
 single argument, the optional argument used in the call to
 `feedmail-run-the-queue' or `feedmail-run-the-queue-no-prompts'.
 Interactively, that argument will be the prefix argument.
-Most people want `mail-send' (bound to C-c C-s in mail-mode), but here's
+\\<mail-mode-map>
+Most people want `mail-send' (bound to \\[mail-send] in `mail-mode'), but here's
 your chance to have something different.  The default value is just a
 wrapper function which discards the optional argument and calls
-mail-send.  If you are a VM user, you might like vm-mail-send, though
+`mail-send'.  If you are a VM user, you might like vm-mail-send, though
 you really don't need that.  Called with funcall, not call-interactively."
   :version "24.1"			; changed default
   :group 'feedmail-queue

lisp/mail/mail-extr.el

@@ -618,7 +618,7 @@ Unless NO-REPLACE is true, at each of the positions in LIST-SYMBOL
  which lie outside of the range, one character at that position is
  replaced with a SPC."
   (or (memq no-replace '(t nil))
-      (error "no-replace must be t or nil, evaluable at macroexpand-time"))
+      (error "`no-replace' must be t or nil, evaluable at macroexpand-time"))
   `(let ((temp ,list-symbol)
 	   ch)
        (while temp

lisp/mail/rmail.el

@@ -519,8 +519,7 @@ For a given message, Rmail applies only the first matching directive.
 
 Examples:
   (\"/dev/null\" \"from\" \"@spam.com\") ; delete all mail from spam.com
-  (\"RMS\" \"from\" \"rms@\") ; save all mail from RMS.
-"
+  (\"RMS\" \"from\" \"rms@\") ; save all mail from RMS."
   :group 'rmail
   :version "21.1"
   :type '(repeat (sexp :tag "Directive")))
@@ -4315,7 +4314,7 @@ In fact, the non-nil value returned is the summary buffer itself."
        rmail-summary-buffer))
 
 (defun rmail-summary-displayed ()
-  "t if in RMAIL buffer and an associated summary buffer is displayed."
+  "Return t if in RMAIL buffer and an associated summary buffer is displayed."
   (and rmail-summary-buffer (get-buffer-window rmail-summary-buffer)))
 
 (defcustom rmail-redisplay-summary nil

lisp/mail/rmailmm.el

@@ -170,7 +170,7 @@ The value is usually nil, and bound to non-nil while inserting
 MIME entities.")
 
 (defvar rmail-mime-searching nil
-  "Bound to T inside `rmail-search-mime-message' to suppress expensive
+  "Bound to t inside `rmail-search-mime-message' to suppress expensive
 operations such as HTML decoding")
 
 ;;; MIME-entity object

lisp/mail/sendmail.el

@@ -671,8 +671,8 @@ switching to, the `*mail*' buffer.  See also `mail-setup-hook'."
   "Major mode for editing mail to be sent.
 Like Text Mode but with these additional commands:
 
-\\[mail-send]  mail-send (send the message)
-\\[mail-send-and-exit]  mail-send-and-exit (send the message and exit)
+\\[mail-send]  `mail-send' (send the message)
+\\[mail-send-and-exit]  `mail-send-and-exit' (send the message and exit)
 
 Here are commands that move to a header field (and create it if there isn't):
 	 \\[mail-to]  move to To:	\\[mail-subject]  move to Subj:
@@ -681,9 +681,9 @@ Here are commands that move to a header field (and create it if there isn't):
          \\[mail-mail-reply-to]  move to Mail-Reply-To:
          \\[mail-mail-followup-to] move to Mail-Followup-To:
 \\[mail-text]  move to message text.
-\\[mail-signature]  mail-signature (insert `mail-signature-file' file).
-\\[mail-yank-original]  mail-yank-original (insert current message, in Rmail).
-\\[mail-fill-yanked-message]  mail-fill-yanked-message (fill what was yanked).
+\\[mail-signature]  `mail-signature' (insert `mail-signature-file' file).
+\\[mail-yank-original]  `mail-yank-original' (insert current message, in Rmail).
+\\[mail-fill-yanked-message]  `mail-fill-yanked-message' (fill what was yanked).
 \\[mail-insert-file] insert a text file into the message.
 \\[mail-add-attachment] attach to the message a file as binary attachment.
 Turning on Mail mode runs the normal hooks `text-mode-hook' and

lisp/mail/supercite.el

@@ -727,7 +727,7 @@ If optional ATTRIBS-P is non-nil, the key/value pair is placed in
 
 ;; mail header nuking
 (defvar sc-mail-last-header-nuked-p nil
-  "True if the last header was nuked.")
+  "Non-nil if the last header was nuked.")
 
 (defun sc-mail-nuke-line ()
   "Nuke the current mail header line."

lisp/mh-e/mh-e.el

@@ -1104,7 +1104,7 @@ and GNU mailutils."
   :package-version '(MH-E . "8.0"))
 
 (defgroup mh-tool-bar nil
-  "The tool bar"
+  "The tool bar."
   :link '(custom-manual "(mh-e)Tool Bar")
   :prefix "mh-"
   :group 'mh-e

lisp/mh-e/mh-folder.el

@@ -520,8 +520,8 @@ font-lock is done highlighting.")
 ;; Autoload cookie needed by desktop.el
 ;;;###autoload
 (define-derived-mode mh-folder-mode fundamental-mode "MH-Folder"
-  "Major MH-E mode for \"editing\" an MH folder scan listing.\\<mh-folder-mode-map>
-
+  "Major MH-E mode for \"editing\" an MH folder scan listing.
+\\<mh-folder-mode-map>
 You can show the message the cursor is pointing to, and step through
 the messages. Messages can be marked for deletion or refiling into
 another folder; these commands are executed all at once with a

lisp/mh-e/mh-search.el

@@ -539,7 +539,7 @@ group of results."
 ;;; Search Menu
 
 (easy-menu-define
-  mh-pick-menu mh-search-mode-map "Menu for MH-E Search"
+  mh-pick-menu mh-search-mode-map "Menu for MH-E Search."
   '("Search"
     ["Perform Search"       mh-index-do-search t]
     ["Search with pick"     mh-pick-do-search t]))
@@ -594,8 +594,8 @@ as well.")
 (put 'mh-search-mode 'mode-class 'special)
 
 (define-derived-mode mh-search-mode fundamental-mode "MH-Search"
-  "Mode for creating search templates in MH-E.\\<mh-search-mode-map>
-
+  "Mode for creating search templates in MH-E.
+\\<mh-search-mode-map>
 Edit this template by entering your search criteria in an
 appropriate header field that is already there, or create a new
 field yourself. If the string you're looking for could be

lisp/mh-e/mh-show.el

@@ -818,8 +818,8 @@ operation."
 
 ;;;###mh-autoload
 (define-derived-mode mh-show-mode text-mode "MH-Show"
-  "Major mode for showing messages in MH-E.\\<mh-show-mode-map>
-
+  "Major mode for showing messages in MH-E.
+\\<mh-show-mode-map>
 Email addresses and URLs in the message are highlighted if the
 option `goto-address-highlight-p' is on, which it is by default.
 To view the web page for a highlighted URL or to send a message

lisp/net/ange-ftp.el

@@ -227,14 +227,14 @@
 
 ;; Tips for using ange-ftp:
 ;;
-;; 1. For dired to work on a host which marks symlinks with a trailing @ in
+;; 1. For Dired to work on a host which marks symlinks with a trailing @ in
 ;;    an ls -alF listing, you need to (setq dired-ls-F-marks-symlinks t).
 ;;    Most UNIX systems do not do this, but ULTRIX does.  If you think that
 ;;    there is a chance you might connect to an ULTRIX machine (such as
 ;;    prep.ai.mit.edu), then set this variable accordingly.  This will have
-;;    the side effect that dired will have problems with symlinks whose names
+;;    the side effect that Dired will have problems with symlinks whose names
 ;;    end in an @.  If you get yourself into this situation then editing
-;;    dired's ls-switches to remove "F", will temporarily fix things.
+;;    Dired's ls-switches to remove "F", will temporarily fix things.
 ;;
 ;; 2. If you know that you are connecting to a certain non-UNIX machine
 ;;    frequently, and ange-ftp seems to be unable to guess its host-type,
@@ -257,8 +257,8 @@
 ;;    moving them through the local machine.  Again, be careful when doing
 ;;    this with binary files on non-Unix machines.
 ;;
-;; 5. Beware that dired over ftp will use your setting of dired-no-confirm
-;;    (list of dired commands for which confirmation is not asked).  You
+;; 5. Beware that Dired over ftp will use your setting of dired-no-confirm
+;;    (list of Dired commands for which confirmation is not asked).  You
 ;;    might want to reconsider your setting of this variable, because you
 ;;    might want confirmation for more commands on remote direds than on
 ;;    local direds.  For example, I strongly recommend that you not include
@@ -266,7 +266,7 @@
 ;;    might be a good idea to have an alist ange-ftp-dired-no-confirm of
 ;;    pairs ( TYPE . LIST ), where TYPE is an operating system type and LIST
 ;;    is a list of commands for which confirmation would be suppressed.  Then
-;;    remote dired listings would take their (buffer-local) value of
+;;    remote Dired listings would take their (buffer-local) value of
 ;;    dired-no-confirm from this alist.  Who votes for this?
 
 ;; ---------------------------------------------------------------------
@@ -317,7 +317,7 @@
 ;;    overwrite FILE.TXT;3, but instead will want to create FILE.TXT;4, and
 ;;    attach the buffer to this file.  To get out of this situation, M-x
 ;;    write-file /ymir.claremont.edu:FILE.TXT will attach the buffer to
-;;    latest version of the file.  For this reason, in dired "f"
+;;    latest version of the file.  For this reason, in Dired "f"
 ;;    (dired-find-file), always loads the file sans version, whereas "v",
 ;;    (dired-view-file), always loads the explicit version number.  The
 ;;    reasoning being that it reasonable to view old versions of a file, but
@@ -514,7 +514,7 @@
 ;;     containing spaces, but beware that the remote ftpd may not like them
 ;;     much.
 ;;
-;; 12. The dired support for non-Unix-like systems does not currently work.
+;; 12. The Dired support for non-Unix-like systems does not currently work.
 ;;     It needs to be reimplemented by modifying the parse-...-listing
 ;;	functions to convert the directory listing to ls -l format.
 ;;
@@ -524,8 +524,8 @@
 ;;     parsing a listing with the F switch.  This will cause ange-ftp to
 ;;     incorrectly get the name of a symlink on a non-ULTRIX host if its name
 ;;     ends in an @.  ange-ftp will correct itself if you take F out of the
-;;     dired ls switches (C-u s will allow you to edit the switches).  The
-;;     dired buffer will be automatically reverted, which will allow ange-ftp
+;;     Dired ls switches (C-u s will allow you to edit the switches).  The
+;;     Dired buffer will be automatically reverted, which will allow ange-ftp
 ;;     to fix its files hashtable.  A cookie to anyone who can think of a
 ;;     fast, sure-fire way to recognize ULTRIX over ftp.
 
@@ -611,9 +611,9 @@
 ;; Thanks to Jamie Zawinski for bugfixes and for ideas such as gateways.
 ;;
 ;; Thanks to Ken Laprade for improved .netrc parsing, password reading, and
-;; dired / shell auto-loading.
+;; Dired / shell auto-loading.
 ;;
-;; Thanks to Sebastian Kremer for dired support and for many ideas and
+;; Thanks to Sebastian Kremer for Dired support and for many ideas and
 ;; bugfixes.
 ;;
 ;; Thanks to Joe Wells for bugfixes, the original non-UNIX system support,

lisp/net/browse-url.el

@@ -113,10 +113,10 @@
 
 ;; Use the Emacs Web Wowser (EWW) when not running under X11:
 ;;	(or (eq window-system 'x)
-;;	    (setq browse-url-browser-function #'eww-browse-url))
+;;	    (setopt browse-url-browser-function #'eww-browse-url))
 
 ;; To always save modified buffers before displaying the file in a browser:
-;;	(setq browse-url-save-file t)
+;;	(setopt browse-url-save-file t)
 
 ;; To invoke different browsers/tools for different URLs, customize
 ;; `browse-url-handlers'.  In earlier versions of Emacs, the same
@@ -419,9 +419,9 @@ value converts ange-ftp-style file names into ftp URLs and prepends
 `file:' to any file name beginning with `/'.
 
 For example, adding to the default a specific translation of an ange-ftp
-address to an HTTP URL:
+address to an HTTPS URL:
 
-    (setq browse-url-filename-alist
+    (setopt browse-url-filename-alist
             \\='((\"/webmaster@webserver:/home/www/html/\" .
                \"https://www.example.org/\")
               (\"^/\\(ftp@\\|anonymous@\\)?\\([^:/]+\\):/*\" . \"ftp://\\2/\")

lisp/net/dictionary.el

@@ -472,7 +472,7 @@ Otherwise, `dictionary-search' displays definitions in a *Dictionary* buffer."
                                    :vert-only t
                                    :help "Go backwards in history.")
     map)
-  "Like the default `tool-bar-map', but with additions for Dictionary mode")
+  "Like the default `tool-bar-map', but with additions for Dictionary mode.")
 
 ;;;###autoload
 (define-derived-mode dictionary-mode special-mode "Dictionary"

lisp/net/eudc.el

@@ -918,7 +918,7 @@ non-nil, collect results from all servers."
              (if valid-comment-given comment nil)))
         (progn
           (error "Error: the function referenced by \
-`eudc-inline-expansion-format' is expected to return a list.")
+`eudc-inline-expansion-format' is expected to return a list")
           nil))))
 
    ;; fallback behavior (nil function, or non-matching type)

lisp/net/eww.el

@@ -1306,7 +1306,7 @@ This consults the entries in `eww-readable-urls' (which see)."
   "Check if point is within a field and toggle text conversion.
 Set `text-conversion-style' to the value `action' if it isn't
 already and point is within the prompt field, or if
-`text-conversion-style' is `nil', so as to guarantee that
+`text-conversion-style' is nil, so as to guarantee that
 the input method functions properly for the purpose of typing
 within text input fields."
   (when (and (eq major-mode 'eww-mode)

lisp/net/rcirc.el

@@ -1197,7 +1197,7 @@ With no argument or nil as argument, use the current buffer."
   "Return PROCESS server name, given by the 001 response."
   (with-rcirc-process-buffer process
     (or rcirc-server-name
-        (warn "server name for process %S unknown" process))))
+        (warn "Server name for process %S unknown" process))))
 
 (defun rcirc-nick (process)
   "Return PROCESS nick."

lisp/net/tramp-cmds.el

@@ -630,7 +630,7 @@ If the buffer runs `dired', the buffer is reverted."
 ;;;###tramp-autoload
 (defun tramp-recompile-elpa-command-completion-p (_symbol _buffer)
   "A predicate for `tramp-recompile-elpa'.
-It is completed by \"M-x TAB\" only if package.el is loaded, and
+It is completed by `M-x TAB' only if package.el is loaded, and
 Tramp is an installed ELPA package."
   ;; We cannot apply `package-installed-p', this would also return the
   ;; builtin package.

lisp/net/tramp-crypt.el

@@ -117,7 +117,7 @@ initializing a new encrypted remote directory."
 ;; `command-completion-default-include-p'.
 (defun tramp-crypt-command-completion-p (symbol _buffer)
   "A predicate for Tramp interactive commands.
-They are completed by \"M-x TAB\" only when encryption support is enabled."
+They are completed by `M-x TAB' only when encryption support is enabled."
   (and tramp-crypt-enabled
        ;; `tramp-crypt-remove-directory' needs to be completed only in
        ;; case we have already encrypted directories.

lisp/net/tramp-message.el

@@ -127,7 +127,7 @@ The outline level is equal to the verbosity of the Tramp message."
 ;; `command-completion-default-include-p'.
 (defun tramp-debug-buffer-command-completion-p (_symbol buffer)
   "A predicate for Tramp interactive commands.
-They are completed by \"M-x TAB\" only in Tramp debug buffers."
+They are completed by `M-x TAB' only in Tramp debug buffers."
   (declare (tramp-suppress-trace t))
   (with-current-buffer buffer
     (string-equal

lisp/net/tramp.el

@@ -2699,7 +2699,7 @@ Run BODY."
 ;; `command-completion-default-include-p'.
 (defun tramp-command-completion-p (_symbol buffer)
   "A predicate for Tramp interactive commands.
-They are completed by \"M-x TAB\" only if the current buffer is remote."
+They are completed by `M-x TAB' only if the current buffer is remote."
   (tramp-tramp-file-p (tramp-get-default-directory buffer)))
 
 (defun tramp-connectable-p (vec-or-filename)

lisp/term/android-win.el

@@ -223,7 +223,7 @@ VALUE should be something suitable for passing to
 ;; time.  This pre-command-hook clears the overlay before any command
 ;; and should be set whenever a preedit overlay is visible.
 (defun android-clear-preedit-text ()
-  "Clear the pre-edit overlay and remove itself from pre-command-hook.
+  "Clear the pre-edit overlay and remove itself from `pre-command-hook'.
 This function should be installed in `pre-command-hook' whenever
 preedit text is displayed."
   (when android-preedit-overlay
@@ -629,4 +629,4 @@ accessible to other programs."
 
 
 (provide 'android-win)
-;; android-win.el ends here.
+;;; android-win.el ends here

lisp/term/pgtk-win.el

@@ -27,7 +27,7 @@
 
 (eval-when-compile (require 'cl-lib))
 (unless (featurep 'pgtk)
-  (error "%s: Loading pgtk-win.el but not compiled with PGTK."
+  (error "%s: Loading pgtk-win.el but not compiled with PGTK"
          invocation-name))
 
 ;; Documentation-purposes only: actually loaded in loadup.el.

lisp/term/x-win.el

@@ -1523,7 +1523,7 @@ This uses `icon-map-list' to map icon file names to stock icon names."
 ;; time.  This pre-command-hook clears the overlay before any command
 ;; and should be set whenever a preedit overlay is visible.
 (defun x-clear-preedit-text ()
-  "Clear the pre-edit overlay and remove itself from pre-command-hook.
+  "Clear the pre-edit overlay and remove itself from `pre-command-hook'.
 This function should be installed in `pre-command-hook' whenever
 preedit text is displayed."
   (when x-preedit-overlay

lisp/textmodes/ispell.el

@@ -2416,7 +2416,7 @@ Global `ispell-quit' is set to start location to continue spell session."
 			    (progn
 			      (set-marker ispell-recursive-edit-marker nil)
 			      (error
-			       "Cannot continue ispell from this buffer.")))
+                               "Cannot continue ispell from this buffer")))
 			(set-marker ispell-recursive-edit-marker nil)))
 		    (list word nil))	; recheck starting at this word.
 		   ((= char ?\C-z)

lisp/textmodes/mhtml-mode.el

@@ -86,7 +86,7 @@ code();
   "Regexp matching the prefix of buffer-locals we want to capture.")
 
 (defun mhtml--construct-submode (mode &rest args)
-  "A wrapper for make-mhtml--submode that computes the buffer-local variables."
+  "A wrapper for `make-mhtml--submode' that computes the buffer-local variables."
   (let ((captured-locals nil)
         (crucial-captured-locals nil)
         (submode (apply #'make-mhtml--submode args)))

lisp/textmodes/page-ext.el

@@ -486,7 +486,7 @@ contain matches to the regexp.)")
 
 (define-obsolete-function-alias 'set-page-delimiter #'pages-set-delimiter "27.1")
 (defun pages-set-delimiter (regexp reset-p &optional interactively)
-  "Set buffer local value of page-delimiter to REGEXP.
+  "Set buffer local value of `page-delimiter' to REGEXP.
 Called interactively with a prefix argument, reset `page-delimiter' to
 its original value.
 

lisp/textmodes/refbib.el

@@ -270,13 +270,13 @@ This is in addition to the `r2b-capitalize-title-stop-words'.")
    (princ (apply (function format) args) r2b-out-buf))
 
 (defun r2b-get-field (var field &optional unique required capitalize)
-   "Set VAR to string value of FIELD, if any.  If none, VAR is set to
-nil.  If multiple fields appear, then separate values with the
-'\\nand\\t\\t', unless UNIQUE is non-nil, in which case log a warning
-and just concatenate the values.  Trim off leading blanks and tabs on
-first line, and trailing blanks and tabs of every line.  Log a warning
-and set VAR to the empty string if REQUIRED is true.  Capitalize as a
-title if CAPITALIZE is true.  Returns value of VAR."
+   "Set VAR to string value of FIELD, if any.
+If none, VAR is set to nil.  If multiple fields appear, then separate
+values with the '\\nand\\t\\t', unless UNIQUE is non-nil, in which case
+log a warning and just concatenate the values.  Trim off leading blanks
+and tabs on first line, and trailing blanks and tabs of every line.  Log
+a warning and set VAR to the empty string if REQUIRED is true.
+Capitalize as a title if CAPITALIZE is true.  Return value of VAR."
    (let (item val (not-past-end t))
       (r2b-trace "snarfing %s" field)
       (goto-char (point-min))
@@ -406,9 +406,10 @@ title if CAPITALIZE is true.  Returns value of VAR."
 
 
 (defun r2b-put-field (field data &optional abbrevs)
-  "Print bibtex FIELD = {DATA} if DATA not null; precede
-with a comma and newline; if ABBREVS list is given, then
-try to replace the {DATA} with an abbreviation."
+  "Print bibtex FIELD = {DATA} if DATA not null; precede with comma and newline.
+
+If ABBREVS list is given, then try to replace the {DATA} with an
+abbreviation."
   (if data
     (let (match nodelim index) ;; multi-line
       (cond

lisp/textmodes/refer.el

@@ -113,9 +113,9 @@ each time it is needed."
 
 (defcustom refer-cache-bib-files t
   "Variable determining whether the value of `refer-bib-files' should be cached.
-If t, initialize the value of refer-bib-files the first time it is used.  If
-nil, re-read the list of \\.bib files depending on the value of `refer-bib-files'
-each time it is needed."
+If t, initialize the value of refer-bib-files the first time it is used.
+If nil, re-read the list of \\.bib files depending on the value of
+`refer-bib-files' each time it is needed."
   :type 'boolean)
 
 (defcustom refer-bib-files-regexp "\\\\bibliography"

lisp/textmodes/reftex-index.el

@@ -1263,7 +1263,7 @@ This gets refreshed in every phrases command.")
 (defun reftex-index-phrase-selection-or-word (arg)
   "Add current selection or word at point to the phrases buffer.
 \\<reftex-index-phrases-mode-map>
-When you are in transient-mark-mode and the region is active, the
+When you are in `transient-mark-mode' and the region is active, the
 selection will be used - otherwise the word at point.
 You get a chance to edit the entry in the phrases buffer - finish with
 \\[reftex-index-phrases-save-and-return]."
@@ -1363,8 +1363,8 @@ If the buffer is non-empty, delete the old header first."
 ;;;###autoload
 (define-derived-mode reftex-index-phrases-mode fundamental-mode "Phrases"
   "Major mode for managing the Index phrases of a LaTeX document.
-This buffer was created with RefTeX. \\<reftex-index-phrases-mode-map>
-
+This buffer was created with RefTeX.
+\\<reftex-index-phrases-mode-map>
 To insert new phrases, use
  - `C-c \\' in the LaTeX document to copy selection or word
  - `\\[reftex-index-new-phrase]' in the phrases buffer.

lisp/textmodes/table.el

@@ -1456,8 +1456,8 @@ first cell.
     |-!-  |     |     |
     +-----+-----+-----+
 
-Inside a table cell, there are special key bindings. \\<table-cell-map>
-
+Inside a table cell, there are special key bindings.
+\\<table-cell-map>
 M-9 \\[table-widen-cell] (or \\[universal-argument] 9 \\[table-widen-cell]) widens the first cell by 9 character
 width, which results as
 
@@ -5301,8 +5301,8 @@ Current buffer must already be set to the cache buffer."
 
 (defun table--fill-region-strictly (beg end)
   "Fill region strictly so that no line exceeds `fill-column'.
-When a word exceeds fill-column the word is chopped into pieces.  The
-chopped location is indicated with table-word-continuation-char."
+When a word exceeds `fill-column' the word is chopped into pieces.  The
+chopped location is indicated with `table-word-continuation-char'."
   (or (and (markerp beg) (markerp end))
       (error "markerp"))
   (if (< fill-column 2)

lisp/url/url-util.el

@@ -378,7 +378,7 @@ These characters are specified in RFC 3986, Appendix A.")
     (aset vec ?\; nil)
     vec)
   "Allowed-character byte mask for keys and values in the query segment of a URI.
-url-query-allowed-chars minus '=', '&', and ';'.")
+`url-query-allowed-chars' minus '=', '&', and ';'.")
 
 ;;;###autoload
 (defun url-encode-url (url)

lisp/url/url.el

@@ -227,7 +227,7 @@ URL-encoded before it's used."
 (defun url-retrieve-synchronously (url &optional silent inhibit-cookies timeout)
   "Retrieve URL synchronously.
 Return the buffer containing the data, or nil if there are no data
-associated with it (the case for dired, info, or mailto URLs that need
+associated with it (the case for Dired, info, or mailto URLs that need
 no further processing).  URL is either a string or a parsed URL.
 
 If SILENT is non-nil, don't do any messaging while retrieving.

lisp/use-package/use-package-core.el

@@ -1669,8 +1669,8 @@ Also see the Info node `(use-package) Creating an extension'."
 (defconst use-package-vc-valid-keywords
   '( :url :branch :lisp-dir :main-file :vc-backend :rev
      :shell-command :make :ignored-files)
-  "Valid keywords for the `:vc' keyword, see the Info
-node `(emacs)Fetching Package Sources'.")
+  "Valid keywords for the `:vc' keyword.
+See Info node `(emacs)Fetching Package Sources'.")
 
 (defun use-package-normalize--vc-arg (arg)
   "Normalize possible arguments to the `:vc' keyword.

lisp/vc/ediff-init.el

@@ -594,7 +594,7 @@ highlighted using ASCII flags."
 (ediff-defvar-local ediff-visible-bounds nil)
 
 (ediff-defvar-local ediff-start-narrowed t
-  "Non-nil means start narrowed, if doing ediff-windows-* or ediff-regions-*")
+  "Non-nil means start narrowed, if doing ediff-windows-* or ediff-regions-*.")
 (ediff-defvar-local ediff-quit-widened t
   "Non-nil means: when finished, Ediff widens buffers A/B.
 Actually, Ediff restores the scope of visibility that existed at startup.")
@@ -624,13 +624,13 @@ It's a number rather than string.")
 
 
 (ediff-defvar-local ediff-buffer-values-orig-A nil
-  "The original values of ediff-protected-variables for buffer A.")
+  "The original values of `ediff-protected-variables' for buffer A.")
 (ediff-defvar-local ediff-buffer-values-orig-B nil
-  "The original values of ediff-protected-variables for buffer B.")
+  "The original values of `ediff-protected-variables' for buffer B.")
 (ediff-defvar-local ediff-buffer-values-orig-C nil
-  "The original values of ediff-protected-variables for buffer C.")
+  "The original values of `ediff-protected-variables' for buffer C.")
 (ediff-defvar-local ediff-buffer-values-orig-Ancestor nil
-  "The original values of ediff-protected-variables for buffer Ancestor.")
+  "The original values of `ediff-protected-variables' for buffer Ancestor.")
 
 (defconst ediff-buffer-values-orig-alist
   '((A . ediff-buffer-values-orig-A)

lisp/vc/ediff-ptch.el

@@ -542,8 +542,8 @@ are two possible targets for this %spatch.  However, these files do not exist."
 
 (defun ediff-get-patch-buffer (&optional arg patch-buf)
   "Obtain patch buffer.  If patch is already in a buffer---use it.
-Else, read patch file into a new buffer. If patch buffer is passed as an
-optional argument, then use it."
+Else, read patch file into a new buffer.  If patch buffer is passed as
+an optional argument, then use it."
   (let ((last-nonmenu-event t) ; Emacs: don't use dialog box
 	last-command-event)    ; XEmacs: don't use dialog box
 

lisp/vc/emerge.el

@@ -128,14 +128,14 @@ copied to the designated output file."
   :type 'boolean)
 
 (defcustom emerge-before-flag "vvvvvvvvvvvvvvvvvvvv\n"
-  "Flag placed above the highlighted block of code.  Must end with newline.
-Must be set before Emerge is loaded, or  emerge-new-flags  must be run
-after setting."
+  "Flag placed above the highlighted block of code.
+Must end with newline.  Must be set before Emerge is loaded, or
+`emerge-new-flags' must be run after setting."
   :type 'string)
 (defcustom emerge-after-flag "^^^^^^^^^^^^^^^^^^^^\n"
-  "Flag placed below the highlighted block of code.  Must end with newline.
-Must be set before Emerge is loaded, or  emerge-new-flags  must be run
-after setting."
+  "Flag placed below the highlighted block of code.
+Must end with newline.  Must be set before Emerge is loaded, or
+`emerge-new-flags' must be run after setting."
   :type 'string)
 
 ;; Hook variables

lisp/vc/vc-dav.el

@@ -1,6 +1,6 @@
 ;;; vc-dav.el --- vc.el support for WebDAV  -*- lexical-binding: t; -*-
 
-;; Copyright (C) 2001, 2004-2024 Free Software Foundation, Inc.
+;; Copyright (C) 2001-2024 Free Software Foundation, Inc.
 
 ;; Author: Bill Perry <wmperry@gnu.org>
 ;; Keywords: url, vc

lisp/vc/vc-git.el

@@ -2177,7 +2177,7 @@ This command shares argument histories with \\[rgrep] and \\[grep]."
 
 (defun vc-git-command (buffer okstatus file-or-list &rest flags)
   "A wrapper around `vc-do-command' for use in vc-git.el.
-The difference to vc-do-command is that this function always invokes
+The difference to `vc-do-command' is that this function always invokes
 `vc-git-program'."
   (let ((coding-system-for-read
          (or coding-system-for-read vc-git-log-output-coding-system))

lisp/vc/vc-hg.el

@@ -1553,7 +1553,7 @@ This runs the command \"hg merge\"."
 
 (defun vc-hg-command (buffer okstatus file-or-list &rest flags)
   "A wrapper around `vc-do-command' for use in vc-hg.el.
-This function differs from vc-do-command in that it invokes
+This function differs from `vc-do-command' in that it invokes
 `vc-hg-program', and passes `vc-hg-global-switches' to it before FLAGS."
   ;; Disable pager.
   (let ((process-environment (cons "HGPLAIN=1" process-environment))

lisp/vc/vc-src.el

@@ -211,7 +211,7 @@ For a description of possible values, see `vc-check-master-templates'."
 
 (defun vc-src-command (buffer file-or-list &rest flags)
   "A wrapper around `vc-do-command' for use in vc-src.el.
-This function differs from vc-do-command in that it invokes `vc-src-program'."
+This function differs from `vc-do-command' in that it invokes `vc-src-program'."
   (let (file-list)
     (cond ((stringp file-or-list)
 	   (setq file-list (list "--" file-or-list)))

lisp/vc/vc-svn.el

@@ -661,7 +661,7 @@ NAME is assumed to be a URL."
 
 (defun vc-svn-command (buffer okstatus file-or-list &rest flags)
   "A wrapper around `vc-do-command' for use in vc-svn.el.
-The difference to vc-do-command is that this function always invokes `svn',
+The difference to `vc-do-command' is that this function always invokes `svn',
 and that it passes `vc-svn-global-switches' to it before FLAGS."
   (apply #'vc-do-command (or buffer "*vc*") okstatus vc-svn-program file-or-list
          (if (stringp vc-svn-global-switches)

lisp/vc/vc.el

@@ -1691,10 +1691,12 @@ Type \\[vc-next-action] to check in changes.")
       "Please explain why you stole the lock.  Type \\`C-c C-c' when done"))))
 
 (defun vc-checkin (files backend &optional comment initial-contents rev patch-string)
-  "Check in FILES. COMMENT is a comment string; if omitted, a
-buffer is popped up to accept a comment.  If INITIAL-CONTENTS is
-non-nil, then COMMENT is used as the initial contents of the log
-entry buffer.
+  "Check in FILES.
+
+COMMENT is a comment string; if omitted, a buffer is popped up to accept
+a comment.  If INITIAL-CONTENTS is non-nil, then COMMENT is used as the
+initial contents of the log entry buffer.
+
 The optional argument REV may be a string specifying the new revision
 level (only supported for some older VCSes, like RCS and CVS).
 The optional argument PATCH-STRING is a string to check in as a patch.