From 5ab5c3898778406103e7183bf41c7d018077092b Mon Sep 17 00:00:00 2001 From: Stefan Kangas Date: Sat, 19 Dec 2020 17:26:58 +0100 Subject: [PATCH] Shorten over-wide docstrings in defcustoms * lisp/calc/calc.el (calc-embedded-announce-formula-alist) (calc-embedded-open-formula, calc-embedded-close-formula) (calc-matrix-mode): * lisp/cedet/semantic/imenu.el (semantic-imenu-sort-bucket-function): * lisp/emacs-lisp/find-func.el (find-feature-regexp): * lisp/emulation/cua-base.el (cua-paste-pop-rotate-temporarily): * lisp/emulation/viper-init.el (viper-fast-keyseq-timeout) (viper-related-files-and-buffers-ring): * lisp/emulation/viper-keym.el (viper-want-ctl-h-help): * lisp/gnus/gnus-art.el (gnus-article-banner-alist): * lisp/gnus/gnus-group.el (gnus-keep-same-level): * lisp/gnus/gnus-score.el (gnus-adaptive-word-length-limit): * lisp/gnus/gnus-sum.el (gnus-inhibit-user-auto-expire): * lisp/gnus/gnus-uu.el (gnus-uu-ignore-files-by-type) (gnus-uu-do-not-unpack-archives) (gnus-uu-unmark-articles-not-decoded) (gnus-uu-correct-stripped-uucode, gnus-uu-save-in-digest) (gnus-uu-post-include-before-composing): * lisp/gnus/gnus.el (gnus-use-long-file-name) (gnus-install-group-spam-parameters): * lisp/gnus/message.el (message-cite-style): * lisp/gnus/nnmail.el (nnmail-split-fancy-with-parent-ignore-groups) (nnmail-cache-ignore-groups): * lisp/ido.el (ido-rewrite-file-prompt-functions): * lisp/mail/feedmail.el (feedmail-fiddle-plex-user-list) (feedmail-spray-address-fiddle-plex-list): * lisp/mh-e/mh-e.el (mh-annotate-msg-hook): * lisp/net/imap.el (imap-process-connection-type): * lisp/net/rcirc.el (rcirc-omit-threshold): * lisp/net/tramp-sh.el (tramp-copy-size-limit): * lisp/nxml/nxml-mode.el (nxml-default-buffer-file-coding-system): * lisp/obsolete/landmark.el (landmark-max-stall-time): * lisp/obsolete/tls.el (tls-checktrust): * lisp/org/org-indent.el (org-indent-mode-turns-off-org-adapt-indentation) (org-indent-mode-turns-on-hiding-stars): * lisp/org/org-protocol.el (org-protocol-project-alist): * lisp/progmodes/cc-vars.el (c-doc-comment-style): * lisp/progmodes/cperl-mode.el (cperl-indent-subs-specially): * lisp/progmodes/flymake-proc.el (flymake-proc-allowed-file-name-masks): * lisp/progmodes/hideif.el (hide-ifdef-expand-reinclusion-protection): * lisp/simple.el (minibuffer-history-case-insensitive-variables): * lisp/tab-bar.el (tab-bar-close-last-tab-choice): * lisp/textmodes/reftex-vars.el (reftex-special-environment-functions): * lisp/vc/ediff-init.el (ediff-startup-hook, ediff-cleanup-hook) (ediff-metachars): * lisp/vc/ediff-merg.el (ediff-show-clashes-only): * lisp/vc/ediff-mult.el (ediff-default-filtering-regexp): Shorten doc strings to not exceed 80-column limits. (Bug#44858) --- lisp/calc/calc.el | 9 +++++---- lisp/cedet/semantic/imenu.el | 3 ++- lisp/emacs-lisp/find-func.el | 2 +- lisp/emulation/cua-base.el | 10 +++++----- lisp/emulation/viper-init.el | 5 +++-- lisp/emulation/viper-keym.el | 2 +- lisp/gnus/gnus-art.el | 4 +++- lisp/gnus/gnus-group.el | 2 +- lisp/gnus/gnus-score.el | 2 +- lisp/gnus/gnus-sum.el | 3 ++- lisp/gnus/gnus-uu.el | 12 ++++++------ lisp/gnus/gnus.el | 5 +++-- lisp/gnus/message.el | 3 ++- lisp/gnus/nnmail.el | 5 +++-- lisp/ido.el | 2 +- lisp/mail/feedmail.el | 18 ++++++++++-------- lisp/mh-e/mh-e.el | 2 +- lisp/net/imap.el | 2 +- lisp/net/rcirc.el | 2 +- lisp/net/tramp-sh.el | 3 +-- lisp/nxml/nxml-mode.el | 6 ++++-- lisp/obsolete/landmark.el | 3 ++- lisp/obsolete/tls.el | 6 ++++-- lisp/org/org-indent.el | 6 ++---- lisp/org/org-protocol.el | 6 ++++-- lisp/progmodes/cc-vars.el | 3 ++- lisp/progmodes/cperl-mode.el | 4 +++- lisp/progmodes/flymake-proc.el | 6 ++++-- lisp/progmodes/hideif.el | 4 ++-- lisp/simple.el | 3 ++- lisp/tab-bar.el | 6 ++++-- lisp/textmodes/reftex-vars.el | 10 ++++++---- lisp/vc/ediff-init.el | 6 +++--- lisp/vc/ediff-merg.el | 2 +- lisp/vc/ediff-mult.el | 2 +- 35 files changed, 97 insertions(+), 72 deletions(-) diff --git a/lisp/calc/calc.el b/lisp/calc/calc.el index bb02281111f..9b45a55aa57 100644 --- a/lisp/calc/calc.el +++ b/lisp/calc/calc.el @@ -266,18 +266,18 @@ (sgml-mode . "\n\\(\n\\)*") (xml-mode . "\n\\(\n\\)*") (texinfo-mode . "@c Embed\n\\(@c .*\n\\)*")) - "Alist of major modes with appropriate values for `calc-embedded-announce-formula'." + "Alist of major modes for `calc-embedded-announce-formula'." :type '(alist :key-type (symbol :tag "Major mode") :value-type (regexp :tag "Regexp to announce formula"))) (defcustom calc-embedded-open-formula "\\`\\|^\n\\|\\$\\$?\\|\\\\\\[\\|^\\\\begin[^{].*\n\\|^\\\\begin{.*[^x]}.*\n\\|^@.*\n\\|^\\.EQ.*\n\\|\\\\(\\|^%\n\\|^\\.\\\\\"\n" - "A regular expression for the opening delimiter of a formula used by calc-embedded." + "Regexp for the opening delimiter of a formula used by `calc-embedded'." :type '(regexp)) (defcustom calc-embedded-close-formula "\\'\\|\n$\\|\\$\\$?\\|\\\\]\\|^\\\\end[^{].*\n\\|^\\\\end{.*[^x]}.*\n\\|^@.*\n\\|^\\.EN.*\n\\|\\\\)\\|\n%\n\\|^\\.\\\\\"\n" - "A regular expression for the closing delimiter of a formula used by calc-embedded." + "Regexp for the closing delimiter of a formula used by calc-embedded." :type '(regexp)) (defcustom calc-embedded-open-close-formula-alist @@ -721,7 +721,8 @@ If nil, computations on numbers always yield numbers where possible.") (defcalcmodevar calc-matrix-mode nil "If `matrix', variables are assumed to be matrix-valued. If a number, variables are assumed to be NxN matrices. -If `sqmatrix', variables are assumed to be square matrices of an unspecified size. +If `sqmatrix', variables are assumed to be square matrices of an + unspecified size. If `scalar', variables are assumed to be scalar-valued. If nil, symbolic math routines make no assumptions about variables.") diff --git a/lisp/cedet/semantic/imenu.el b/lisp/cedet/semantic/imenu.el index 25f7fdb8426..c910dc8fc6b 100644 --- a/lisp/cedet/semantic/imenu.el +++ b/lisp/cedet/semantic/imenu.el @@ -99,7 +99,8 @@ Overridden to nil if `semantic-imenu-bucketize-file' is nil." (defcustom semantic-imenu-sort-bucket-function nil "Function to use when sorting tags in the buckets of functions. -See `semantic-bucketize' and the FILTER argument for more details on this function." +See `semantic-bucketize' and the FILTER argument for more details +on this function." :group 'semantic-imenu :type '(radio (const :tag "No Sorting" nil) (const semantic-sort-tags-by-name-increasing) diff --git a/lisp/emacs-lisp/find-func.el b/lisp/emacs-lisp/find-func.el index ee94e1fbff7..074e7db295b 100644 --- a/lisp/emacs-lisp/find-func.el +++ b/lisp/emacs-lisp/find-func.el @@ -103,7 +103,7 @@ Please send improvements and fixes to the maintainer." (defcustom find-feature-regexp (concat ";;; Code:") - "The regexp used by `xref-find-definitions' when searching for a feature definition. + "Regexp used by `xref-find-definitions' when searching for a feature definition. Note it may contain up to one `%s' at the place where `format' should insert the feature name." ;; We search for ";;; Code" rather than (feature '%s) because the diff --git a/lisp/emulation/cua-base.el b/lisp/emulation/cua-base.el index 926305e6077..55578d06229 100644 --- a/lisp/emulation/cua-base.el +++ b/lisp/emulation/cua-base.el @@ -375,11 +375,11 @@ managers, so try setting this to nil, if prefix override doesn't work." (defcustom cua-paste-pop-rotate-temporarily nil "If non-nil, \\[cua-paste-pop] only rotates the kill-ring temporarily. -This means that both \\[yank] and the first \\[yank-pop] in a sequence always insert -the most recently killed text. Each immediately following \\[cua-paste-pop] replaces -the previous text with the next older element on the `kill-ring'. -With prefix arg, \\[universal-argument] \\[yank-pop] inserts the same text as the most -recent \\[yank-pop] (or \\[yank]) command." +This means that both \\[yank] and the first \\[yank-pop] in a sequence always +insert the most recently killed text. Each immediately following \\[cua-paste-pop] +replaces the previous text with the next older element on the `kill-ring'. +With prefix arg, \\[universal-argument] \\[yank-pop] inserts the same text as the +most recent \\[yank-pop] (or \\[yank]) command." :type 'boolean :group 'cua) diff --git a/lisp/emulation/viper-init.el b/lisp/emulation/viper-init.el index 6c4afe519f2..c2aae9b87fb 100644 --- a/lisp/emulation/viper-init.el +++ b/lisp/emulation/viper-init.el @@ -475,7 +475,8 @@ text." ;; Fast keyseq and ESC keyseq timeouts (defcustom viper-fast-keyseq-timeout 200 - "Key sequence separated by no more than this many milliseconds is viewed as a Vi-style macro, if such a macro is defined. + "Max milliseconds for a key sequence to be regarded as a Vi-style macro. +Only regard key sequence as a macro if it is defined. Setting this too high may slow down your typing. Setting this value too low will make it hard to use Vi-style timeout macros." :type 'integer @@ -705,7 +706,7 @@ If nil, the cursor will move backwards without deleting anything." (viper-deflocalvar viper-related-files-and-buffers-ring nil "") (defcustom viper-related-files-and-buffers-ring nil - "List of file and buffer names that are considered to be related to the current buffer. + "List of file and buffer names to consider related to the current buffer. Related buffers can be cycled through via :R and :P commands." :type 'boolean :group 'viper-misc) diff --git a/lisp/emulation/viper-keym.el b/lisp/emulation/viper-keym.el index d76cf71b314..6a0fc2e9842 100644 --- a/lisp/emulation/viper-keym.el +++ b/lisp/emulation/viper-keym.el @@ -69,7 +69,7 @@ major mode in effect." :group 'viper) (defcustom viper-want-ctl-h-help nil - "If non-nil, C-h gets bound to help-command; otherwise, C-h gets the usual Vi bindings." + "If non-nil, bind C-h to help-command; otherwise, C-h gets the usual Vi bindings." :type 'boolean :group 'viper) diff --git a/lisp/gnus/gnus-art.el b/lisp/gnus/gnus-art.el index 5b50bcbbe1f..79d4d9087fb 100644 --- a/lisp/gnus/gnus-art.el +++ b/lisp/gnus/gnus-art.el @@ -289,7 +289,9 @@ asynchronously. The compressed face will be piped to this command." (defcustom gnus-article-banner-alist nil "Banner alist for stripping. For example, - ((egroups . \"^[ \\t\\n]*-------------------+\\\\( \\\\(e\\\\|Yahoo! \\\\)Groups Sponsor -+\\\\)?....\\n\\\\(.+\\n\\\\)+\"))" + ((egroups . (concat \"^[ \\t\\n]*-------------------+\\\\\" + \"( \\\\(e\\\\|Yahoo! \\\\)Groups Sponsor -+\\\\)?\" + \"....\\n\\\\(.+\\n\\\\)+\")))" :version "21.1" :type '(repeat (cons symbol regexp)) :group 'gnus-article-washing) diff --git a/lisp/gnus/gnus-group.el b/lisp/gnus/gnus-group.el index 24534a1b66d..9bb3ec765ff 100644 --- a/lisp/gnus/gnus-group.el +++ b/lisp/gnus/gnus-group.el @@ -60,7 +60,7 @@ :type 'string) (defcustom gnus-keep-same-level nil - "Non-nil means that the next newsgroup after the current will be on the same level. + "Non-nil means that the newsgroup after this one will be on the same level. When you type, for instance, `n' after reading the last article in the current newsgroup, you will go to the next newsgroup. If this variable is nil, the next newsgroup will be the next from the group diff --git a/lisp/gnus/gnus-score.el b/lisp/gnus/gnus-score.el index 94f2cc310fa..33c5803f5ab 100644 --- a/lisp/gnus/gnus-score.el +++ b/lisp/gnus/gnus-score.el @@ -248,7 +248,7 @@ If you use score decays, you might want to set values higher than (integer :tag "Score")))))) (defcustom gnus-adaptive-word-length-limit nil - "Words of a length lesser than this limit will be ignored when doing adaptive scoring." + "Words shorter than this limit will be ignored when doing adaptive scoring." :version "22.1" :group 'gnus-score-adapt :type '(radio (const :format "Unlimited " nil) diff --git a/lisp/gnus/gnus-sum.el b/lisp/gnus/gnus-sum.el index 16152e252a0..b8b055c02ce 100644 --- a/lisp/gnus/gnus-sum.el +++ b/lisp/gnus/gnus-sum.el @@ -744,7 +744,8 @@ string with the suggested prefix." :type '(repeat character)) (defcustom gnus-inhibit-user-auto-expire t - "If non-nil, user marking commands will not mark an article as expirable, even if the group has auto-expire turned on." + "If non-nil, user marking commands will not mark an article as expirable. +This is true even if the group has auto-expire turned on." :version "21.1" :group 'gnus-summary :type 'boolean) diff --git a/lisp/gnus/gnus-uu.el b/lisp/gnus/gnus-uu.el index 70aeac00d7f..5980051ee45 100644 --- a/lisp/gnus/gnus-uu.el +++ b/lisp/gnus/gnus-uu.el @@ -162,7 +162,7 @@ Note that this variable can be used in conjunction with the (regexp :format "%v"))) (defcustom gnus-uu-ignore-files-by-type nil - "A regular expression saying what files that shouldn't be viewed, based on MIME file type. + "Regexp matching files that shouldn't be viewed, based on MIME file type. If, for instance, you want gnus-uu to ignore all audio files and all mpegs, you could say something like @@ -224,7 +224,7 @@ Default is \"/tmp/\"." :type 'directory) (defcustom gnus-uu-do-not-unpack-archives nil - "Non-nil means that gnus-uu won't peek inside archives looking for files to display. + "If non-nil, gnus-uu won't peek inside archives looking for files to display. Default is nil." :group 'gnus-extract-archive :type 'boolean) @@ -265,19 +265,19 @@ it nil." :type 'boolean) (defcustom gnus-uu-unmark-articles-not-decoded nil - "Non-nil means that gnus-uu will mark articles that were unsuccessfully decoded as unread. + "If non-nil, gnus-uu will mark unsuccessfully decoded articles as unread. Default is nil." :group 'gnus-extract :type 'boolean) (defcustom gnus-uu-correct-stripped-uucode nil - "Non-nil means that gnus-uu will *try* to fix uuencoded files that have had trailing spaces deleted. + "If non-nil, *try* to fix uuencoded files that have had trailing spaces deleted. Default is nil." :group 'gnus-extract :type 'boolean) (defcustom gnus-uu-save-in-digest nil - "Non-nil means that gnus-uu, when asked to save without decoding, will save in digests. + "If non-nil, gnus-uu, when asked to save without decoding, will save in digests. If this variable is nil, gnus-uu will just save everything in a file without any embellishments. The digesting almost conforms to RFC1153 - no easy way to specify any meaningful volume and issue numbers were found, @@ -1858,7 +1858,7 @@ uuencode and adds MIME headers." (function :tag "Other"))) (defcustom gnus-uu-post-include-before-composing nil - "Non-nil means that gnus-uu will ask for a file to encode before you compose the article. + "If non-nil, gnus-uu asks for a file to encode before you compose the article. If this variable is t, you can either include an encoded file with \\[gnus-uu-post-insert-binary-in-article] or have one included for you when you post the article." :group 'gnus-extract-post diff --git a/lisp/gnus/gnus.el b/lisp/gnus/gnus.el index 8e8af1521fa..653ef1bbfdb 100644 --- a/lisp/gnus/gnus.el +++ b/lisp/gnus/gnus.el @@ -1195,7 +1195,7 @@ Also see `gnus-large-ephemeral-newsgroup'." integer)) (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v))) - "Non-nil means that the default name of a file to save articles in is the group name. + "Non-nil means that the default file name to save articles in is the group name. If it's nil, the directory form of the group name is used instead. If this variable is a list, and the list contains the element @@ -1618,7 +1618,8 @@ total number of articles in the group.") ;; group parameters for spam processing added by Ted Zlatanov (defcustom gnus-install-group-spam-parameters t "Disable the group parameters for spam detection. -Enable if `G c' in XEmacs is giving you trouble, and make sure to submit a bug report." +Enable if `G c' in XEmacs is giving you trouble, and make sure to +submit a bug report." :version "22.1" :type 'boolean :group 'gnus-start) diff --git a/lisp/gnus/message.el b/lisp/gnus/message.el index b6c1c0b0713..cf4020c874c 100644 --- a/lisp/gnus/message.el +++ b/lisp/gnus/message.el @@ -1172,7 +1172,8 @@ Presets to impersonate popular mail agents are found in the message-cite-style-* variables. This variable is intended for use in `gnus-posting-styles', such as: - ((posting-from-work-p) (eval (setq-local message-cite-style message-cite-style-outlook)))" + ((posting-from-work-p) (eval (setq-local message-cite-style + message-cite-style-outlook)))" :version "24.1" :group 'message-insertion :type '(choice (const :tag "Do not override variables" :value nil) diff --git a/lisp/gnus/nnmail.el b/lisp/gnus/nnmail.el index 57801d6f9e6..6ee29a25cd8 100644 --- a/lisp/gnus/nnmail.el +++ b/lisp/gnus/nnmail.el @@ -115,7 +115,7 @@ If nil, the first match found will be used." :type 'boolean) (defcustom nnmail-split-fancy-with-parent-ignore-groups nil - "Regexp that matches group names to be ignored when applying `nnmail-split-fancy-with-parent'. + "Regexp matching group names ignored by `nnmail-split-fancy-with-parent'. This can also be a list of regexps." :version "22.1" :group 'nnmail-split @@ -124,7 +124,8 @@ This can also be a list of regexps." (repeat :value (".*") regexp))) (defcustom nnmail-cache-ignore-groups nil - "Regexp that matches group names to be ignored when inserting message ids into the cache (`nnmail-cache-insert'). + "Regexp matching group ignored when inserting message ids into the cache. +This is used by `nnmail-cache-insert'. This can also be a list of regexps." :version "22.1" :group 'nnmail-split diff --git a/lisp/ido.el b/lisp/ido.el index 99241ce1a3a..277ce15a3a9 100644 --- a/lisp/ido.el +++ b/lisp/ido.el @@ -842,7 +842,7 @@ variables: max-width - the max width of the resulting dirname; nil means no limit prompt - the basic prompt (e.g. \"Find File: \") literal - the string shown if doing \"literal\" find; set to nil to omit - vc-off - the string shown if version control is inhibited; set to nil to omit + vc-off - the string shown if version control is inhibited; use nil to omit prefix - either nil or a fixed prefix for the dirname The following variables are available, but should not be changed: diff --git a/lisp/mail/feedmail.el b/lisp/mail/feedmail.el index 6f8c013ba35..2907093ea71 100644 --- a/lisp/mail/feedmail.el +++ b/lisp/mail/feedmail.el @@ -807,7 +807,8 @@ fiddle-plex. feedmail will use this list of fiddle-plexes to manipulate user-specified message header fields. It does this after it has completed all normal -message header field manipulation and before calling `feedmail-last-chance-hook'. +message header field manipulation and before calling +`feedmail-last-chance-hook'. For an explanation of fiddle-plexes, see the documentation for the variable `feedmail-fiddle-plex-blurb'. In contrast to some other fiddle-plex @@ -889,13 +890,14 @@ called and will consult `feedmail-spray-this-address' to find the stripped envelope email address (no comments or angle brackets). The function should return an embellished form of the address. -The recipe for sending form letters is: (1) create a message with all -addressees on Bcc: headers; (2) tell feedmail to remove Bcc: headers -before sending the message; (3) create a function which will embellish -stripped addresses, if desired; (4) define `feedmail-spray-address-fiddle-plex-list' -appropriately; (5) send the message with `feedmail-enable-spray' set -non-nil; (6) stand back and watch co-workers wonder at how efficient -you are at accomplishing inherently inefficient things." +The recipe for sending form letters is: (1) create a message with +all addressees on Bcc: headers; (2) tell feedmail to remove Bcc: +headers before sending the message; (3) create a function which +will embellish stripped addresses, if desired; (4) define +`feedmail-spray-address-fiddle-plex-list' appropriately; (5) send +the message with `feedmail-enable-spray' set non-nil; (6) stand +back and watch co-workers wonder at how efficient you are at +accomplishing inherently inefficient things." :group 'feedmail-spray :type 'sexp ; too complex to be described accurately ) diff --git a/lisp/mh-e/mh-e.el b/lisp/mh-e/mh-e.el index 3ac5c8f7aed..e5f69a5ae8d 100644 --- a/lisp/mh-e/mh-e.el +++ b/lisp/mh-e/mh-e.el @@ -3182,7 +3182,7 @@ folder, which is also available in `mh-current-folder'." :package-version '(MH-E . "8.0")) (defcustom-mh mh-annotate-msg-hook nil - "Hook run whenever a message is sent and after the scan lines and message are annotated. + "Hook run when a message is sent and after annotating the scan lines and message. Hook functions can access the current folder name with `mh-current-folder' and obtain the message numbers of the annotated messages with `mh-annotate-list'." diff --git a/lisp/net/imap.el b/lisp/net/imap.el index 0394f0efeae..27c2d869f6b 100644 --- a/lisp/net/imap.el +++ b/lisp/net/imap.el @@ -190,7 +190,7 @@ until a successful connection is made." :type '(repeat string)) (defcustom imap-process-connection-type nil - "Value for `process-connection-type' to use for Kerberos4, GSSAPI, shell, and SSL. + "Value for `process-connection-type' to use for Kerberos4, GSSAPI, shell and SSL. The `process-connection-type' variable controls the type of device used to communicate with subprocesses. Values are nil to use a pipe, or t or `pty' to use a pty. The value has no effect if the diff --git a/lisp/net/rcirc.el b/lisp/net/rcirc.el index c4b68f1be4e..6a32fa9255b 100644 --- a/lisp/net/rcirc.el +++ b/lisp/net/rcirc.el @@ -1507,7 +1507,7 @@ is found by looking up RESPONSE in `rcirc-response-formats'." (make-variable-buffer-local 'rcirc-last-sender) (defcustom rcirc-omit-threshold 100 - "Number of lines since last activity from a nick before `rcirc-omit-responses' are omitted." + "Lines since last activity from a nick before `rcirc-omit-responses' are omitted." :type 'integer) (defcustom rcirc-log-process-buffers nil diff --git a/lisp/net/tramp-sh.el b/lisp/net/tramp-sh.el index e30fe61de43..e6e718ebe3b 100644 --- a/lisp/net/tramp-sh.el +++ b/lisp/net/tramp-sh.el @@ -58,8 +58,7 @@ If it is nil, no compression at all will be applied." ;;;###tramp-autoload (defcustom tramp-copy-size-limit 10240 - "The maximum file size where inline copying is preferred over an \ -out-of-the-band copy. + "Maximum file size where inline copying is preferred to an out-of-the-band copy. If it is nil, out-of-the-band copy will be used without a check." :group 'tramp :type '(choice (const nil) integer)) diff --git a/lisp/nxml/nxml-mode.el b/lisp/nxml/nxml-mode.el index 5bb904e6915..080b8c0c6e8 100644 --- a/lisp/nxml/nxml-mode.el +++ b/lisp/nxml/nxml-mode.el @@ -107,8 +107,10 @@ and when the encoding declaration specifies `UTF-16'." (defcustom nxml-default-buffer-file-coding-system nil "Default value for `buffer-file-coding-system' for a buffer for a new file. -A value of nil means use the default value of `buffer-file-coding-system' as normal. -A buffer's `buffer-file-coding-system' affects what \\[nxml-insert-xml-declaration] inserts." +A value of nil means use the default value of +`buffer-file-coding-system' as normal. +A buffer's `buffer-file-coding-system' affects what +\\[nxml-insert-xml-declaration] inserts." :group 'nxml :type 'coding-system) diff --git a/lisp/obsolete/landmark.el b/lisp/obsolete/landmark.el index df3c5d6cc9e..39e0f50e731 100644 --- a/lisp/obsolete/landmark.el +++ b/lisp/obsolete/landmark.el @@ -1278,7 +1278,8 @@ Used to move the robot when he is stuck in a rut for some reason." :group 'landmark) (defcustom landmark-max-stall-time 2 "The maximum number of cycles that the robot can remain stuck in a place. -After this limit is reached, landmark-random-move is called to push him out of it." +After this limit is reached, landmark-random-move is called to +push him out of it." :type 'integer :group 'landmark) diff --git a/lisp/obsolete/tls.el b/lisp/obsolete/tls.el index d1b215cbfb8..a9d7b843736 100644 --- a/lisp/obsolete/tls.el +++ b/lisp/obsolete/tls.el @@ -130,8 +130,10 @@ the external program knows about the root certificates you consider trustworthy, e.g.: \(setq tls-program - \\='(\"gnutls-cli --x509cafile /etc/ssl/certs/ca-certificates.crt -p %p %h\" - \"gnutls-cli --x509cafile /etc/ssl/certs/ca-certificates.crt -p %p %h --protocols ssl3\"))" + \\='(\"gnutls-cli --x509cafile /etc/ssl/certs/ca-certificates.crt \\ +-p %p %h\" + \"gnutls-cli --x509cafile /etc/ssl/certs/ca-certificates.crt \\ +-p %p %h --protocols ssl3\"))" :type '(choice (const :tag "Always" t) (const :tag "Never" nil) (const :tag "Ask" ask)) diff --git a/lisp/org/org-indent.el b/lisp/org/org-indent.el index 73b077965c4..708b5c305ef 100644 --- a/lisp/org/org-indent.el +++ b/lisp/org/org-indent.el @@ -85,15 +85,13 @@ it may be prettier to customize the `org-indent' face." :type 'character) (defcustom org-indent-mode-turns-off-org-adapt-indentation t - "Non-nil means setting the variable `org-indent-mode' will \ -turn off indentation adaptation. + "Non-nil means setting `org-indent-mode' will turn off indentation adaptation. For details see the variable `org-adapt-indentation'." :group 'org-indent :type 'boolean) (defcustom org-indent-mode-turns-on-hiding-stars t - "Non-nil means setting the variable `org-indent-mode' will \ -turn on `org-hide-leading-stars'." + "Non-nil means setting `org-indent-mode' will turn on `org-hide-leading-stars'." :group 'org-indent :type 'boolean) diff --git a/lisp/org/org-protocol.el b/lisp/org/org-protocol.el index 4bc7cee31fc..92ec24415b7 100644 --- a/lisp/org/org-protocol.el +++ b/lisp/org/org-protocol.el @@ -181,7 +181,8 @@ Possible properties are: :working-directory - the local working directory. This is, what base-url will be replaced with. :redirects - A list of cons cells, each of which maps a regular - expression to match to a path relative to :working-directory. + expression to match to a path relative to + :working-directory. Example: @@ -202,7 +203,8 @@ Example: :working-directory \"~/site/content/post/\" :online-suffix \".html\" :working-suffix \".md\" - :rewrites ((\"\\(https://site.com/[0-9]+/[0-9]+/[0-9]+/\\)\" . \".md\"))) + :rewrites ((\"\\(https://site.com/[0-9]+/[0-9]+/[0-9]+/\\)\" + . \".md\"))) (\"GNU emacs OpenGrok\" :base-url \"https://opengrok.housegordon.com/source/xref/emacs/\" :working-directory \"~/dev/gnu-emacs/\"))) diff --git a/lisp/progmodes/cc-vars.el b/lisp/progmodes/cc-vars.el index 9e6f9527ca1..8772ed06324 100644 --- a/lisp/progmodes/cc-vars.el +++ b/lisp/progmodes/cc-vars.el @@ -575,7 +575,8 @@ comment styles: javadoc -- Javadoc style for \"/** ... */\" comments (default in Java mode). autodoc -- Pike autodoc style for \"//! ...\" comments (default in Pike mode). - gtkdoc -- GtkDoc style for \"/** ... **/\" comments (default in C and C++ modes). + gtkdoc -- GtkDoc style for \"/** ... **/\" comments + (default in C and C++ modes). doxygen -- Doxygen style. The value may also be a list of doc comment styles, in which case all diff --git a/lisp/progmodes/cperl-mode.el b/lisp/progmodes/cperl-mode.el index 15987a3b9b1..87542ea133c 100644 --- a/lisp/progmodes/cperl-mode.el +++ b/lisp/progmodes/cperl-mode.el @@ -232,7 +232,9 @@ Versions 5.2 ... 5.20 behaved as if this were nil." :group 'cperl-indentation-details) (defcustom cperl-indent-subs-specially t - "Non-nil means indent subs that are inside other blocks (hash values, for example) relative to the beginning of the \"sub\" keyword, rather than relative to the statement that contains the declaration." + "If non-nil, indent subs inside other blocks relative to \"sub\" keyword. +Otherwise, indent them relative to statement that contains the declaration. +This applies to, for example, hash values." :type 'boolean :group 'cperl-indentation-details) diff --git a/lisp/progmodes/flymake-proc.el b/lisp/progmodes/flymake-proc.el index 152dc725c74..744c110f6b0 100644 --- a/lisp/progmodes/flymake-proc.el +++ b/lisp/progmodes/flymake-proc.el @@ -120,8 +120,10 @@ This is an alist with elements of the form: REGEXP INIT [CLEANUP [NAME]] REGEXP is a regular expression that matches a file name. INIT is the init function to use. -CLEANUP is the cleanup function to use, default `flymake-proc-simple-cleanup'. -NAME is the file name function to use, default `flymake-proc-get-real-file-name'." +CLEANUP is the cleanup function to use, default + `flymake-proc-simple-cleanup'. +NAME is the file name function to use, default + `flymake-proc-get-real-file-name'." :group 'flymake :type '(alist :key-type (regexp :tag "File regexp") :value-type diff --git a/lisp/progmodes/hideif.el b/lisp/progmodes/hideif.el index 9c8343fca00..fb487f7e1f2 100644 --- a/lisp/progmodes/hideif.el +++ b/lisp/progmodes/hideif.el @@ -153,8 +153,8 @@ The first time we visit such a file, _XXX_HEADER_FILE_INCLUDED_ is undefined, and so nothing is hidden. The next time we visit it, everything will be hidden. -This behavior is generally undesirable. If this option is non-nil, the outermost -#if is always visible." +This behavior is generally undesirable. If this option is non-nil, the +outermost #if is always visible." :type 'boolean :version "25.1") diff --git a/lisp/simple.el b/lisp/simple.el index 090162b973a..9ed7a11de19 100644 --- a/lisp/simple.el +++ b/lisp/simple.el @@ -2200,7 +2200,8 @@ in this use of the minibuffer.") "Minibuffer history variables for which matching should ignore case. If a history variable is a member of this list, then the \\[previous-matching-history-element] and \\[next-matching-history-element]\ - commands ignore case when searching it, regardless of `case-fold-search'." + commands ignore case when searching it, +regardless of `case-fold-search'." :type '(repeat variable) :group 'minibuffer) diff --git a/lisp/tab-bar.el b/lisp/tab-bar.el index 9506b1b22ea..8c649bd507a 100644 --- a/lisp/tab-bar.el +++ b/lisp/tab-bar.el @@ -852,8 +852,10 @@ If `recent', select the most recently visited tab." "Defines what to do when the last tab is closed. If nil, do nothing and show a message, like closing the last window or frame. If `delete-frame', delete the containing frame, as a web browser would do. -If `tab-bar-mode-disable', disable tab-bar-mode so that tabs no longer show in the frame. -If the value is a function, call that function with the tab to be closed as an argument." +If `tab-bar-mode-disable', disable tab-bar-mode so that tabs no longer show in +the frame. +If the value is a function, call that function with the tab to be closed as an + argument." :type '(choice (const :tag "Do nothing and show message" nil) (const :tag "Close the containing frame" delete-frame) (const :tag "Disable tab-bar-mode" tab-bar-mode-disable) diff --git a/lisp/textmodes/reftex-vars.el b/lisp/textmodes/reftex-vars.el index c9fd19d2324..f73b849b6dd 100644 --- a/lisp/textmodes/reftex-vars.el +++ b/lisp/textmodes/reftex-vars.el @@ -741,8 +741,8 @@ The function must take an argument BOUND. If non-nil, BOUND is a boundary for backwards searches which should be observed. Here is an example. The LaTeX package linguex.sty defines list macros -`\\ex.', `\\a.', etc for lists which are terminated by `\\z.' or an empty -line. +`\\ex.', `\\a.', etc for lists which are terminated by `\\z.' or an +empty line. \\ex. \\label{ex:12} Some text in an exotic language ... \\a. \\label{ex:13} more stuff @@ -766,10 +766,12 @@ And here is the setup for RefTeX: (save-excursion ;; Search for any of the linguex item macros at the beginning of a line (if (re-search-backward - \"^[ \\t]*\\\\(\\\\\\\\\\\\(ex\\\\|a\\\\|b\\\\|c\\\\|d\\\\|e\\\\|f\\\\)g?\\\\.\\\\)\" bound t) + (concat \"^[ \\t]*\\\\(\\\\\\\\\\\\(ex\\\\|a\\\\|\" + \"b\\\\|c\\\\|d\\\\|e\\\\|f\\\\)g?\\\\.\\\\)\") + bound t) (progn (setq p1 (match-beginning 1)) - ;; Make sure no empty line or \\z. is between us and the item macro + ;; Make sure no empty line or \\z. is between us and item macro (if (re-search-forward \"\\n[ \\t]*\\n\\\\|\\\\\\\\z\\\\.\" pos t) ;; Return nil because list was already closed nil diff --git a/lisp/vc/ediff-init.el b/lisp/vc/ediff-init.el index 8974692751f..3d16f316a63 100644 --- a/lisp/vc/ediff-init.el +++ b/lisp/vc/ediff-init.el @@ -432,7 +432,7 @@ Can be used to move the frame where it is desired." :type 'hook :group 'ediff-hook) (defcustom ediff-startup-hook nil - "Hooks to run in the control buffer after Ediff has been set up and is ready for the job." + "Hooks to run in the control buffer after Ediff has been set up and is ready." :type 'hook :group 'ediff-hook) (defcustom ediff-select-hook nil @@ -480,7 +480,7 @@ set local variables that determine how the display looks like." :type 'hook :group 'ediff-hook) (defcustom ediff-cleanup-hook nil - "Hooks to run on exiting Ediff but before killing the control and variant buffers." + "Hooks to run on exiting Ediff, before killing the control and variant buffers." :type 'hook :group 'ediff-hook) @@ -1268,7 +1268,7 @@ Instead, C-h would jump to previous difference." ;; Metacharacters that have to be protected from the shell when executing ;; a diff/diff3 command. (defcustom ediff-metachars "[ \t\n!\"#$&'()*;<=>?[\\^`{|~]" - "Regexp that matches characters that must be quoted with `\\' in shell command line. + "Regexp matching characters that must be quoted with `\\' in shell command line. This default should work without changes." :type 'regexp :group 'ediff) diff --git a/lisp/vc/ediff-merg.el b/lisp/vc/ediff-merg.el index 22656761d91..1c1d5219c7b 100644 --- a/lisp/vc/ediff-merg.el +++ b/lisp/vc/ediff-merg.el @@ -70,7 +70,7 @@ STRING4 :group 'ediff-merge) (defcustom ediff-show-clashes-only nil - "If t, show only those diff regions where both buffers disagree with the ancestor. + "If t, show only diff regions where both buffers disagree with the ancestor. This means that regions that have status prefer-A or prefer-B will be skipped over. A value of nil means show all regions." :type 'boolean diff --git a/lisp/vc/ediff-mult.el b/lisp/vc/ediff-mult.el index b48377815a4..3d79630f3bb 100644 --- a/lisp/vc/ediff-mult.el +++ b/lisp/vc/ediff-mult.el @@ -181,7 +181,7 @@ directories.") (defvar ediff-filtering-regexp-history nil "") (defcustom ediff-default-filtering-regexp nil - "The default regular expression used as a filename filter in multifile comparisons. + "Default regular expression used as a filename filter in multifile comparisons. Should be a sexp. For instance (car ediff-filtering-regexp-history) or nil." :type 'sexp ; yuck - why not just a regexp? :risky t) -- 2.39.2