Commit 5ab5c389 authored by Stefan Kangas's avatar Stefan Kangas
Browse files

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)
parent 4c7df434
......@@ -266,18 +266,18 @@
(sgml-mode . "<!-- Embed -->\n\\(<!-- .* -->\n\\)*")
(xml-mode . "<!-- Embed -->\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.")
......
......@@ -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)
......
......@@ -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
......
......@@ -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)
......
......@@ -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)
......
......@@ -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)
......
......@@ -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)
......
......@@ -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
......
......@@ -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)
......
......@@ -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)
......
......@@ -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
......
......@@ -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 <tzz@lifelogs.com>
(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)
......
......@@ -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)
......
......@@ -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
......
......@@ -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:
......
......@@ -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
)
......
......@@ -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'."
......
......@@ -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
......
......@@ -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
......
......@@ -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))
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment