[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Emacs-diffs] master b27c670: Leading "*" in the doc of defvars is long
|
From: |
Glenn Morris |
|
Subject: |
[Emacs-diffs] master b27c670: Leading "*" in the doc of defvars is long obsolete. |
|
Date: |
Fri, 10 Jun 2016 04:23:55 +0000 (UTC) |
branch: master
commit b27c670b9f28b3fd24d3e57ba0c75966964ccf82
Author: Glenn Morris <address@hidden>
Commit: Glenn Morris <address@hidden>
Leading "*" in the doc of defvars is long obsolete.
* lisp/plstore.el (plstore-encrypt-to):
* lisp/cedet/semantic/lex-spp.el
(semantic-lex-spp-macro-max-length-to-save):
* lisp/cedet/semantic/symref.el (semantic-symref-tool):
* lisp/cedet/semantic/bovine/el.el
(semantic-elisp-store-documentation-in-tag):
* lisp/cedet/semantic/wisent/comp.el (wisent-verbose-flag)
(wisent-expected-conflicts):
* lisp/cedet/semantic/wisent/wisent.el (wisent-parse-verbose-flag):
* lisp/gnus/gnus-agent.el (gnus-category-menu-hook):
* lisp/gnus/gnus-group.el (gnus-group-listing-limit):
* lisp/gnus/gnus-srvr.el (gnus-server-menu-hook)
(gnus-browse-menu-hook):
* lisp/gnus/message.el (message-shoot-gnksa-feet):
* lisp/gnus/mm-decode.el (mm-path-name-rewrite-functions):
* lisp/gnus/mm-util.el (mm-extra-numeric-entities):
* lisp/gnus/mm-view.el (mm-w3m-standalone-supports-m17n-p):
* lisp/gnus/mml.el (mml-generate-multipart-alist):
* lisp/gnus/nndraft.el (nndraft-required-headers):
* lisp/gnus/nnheader.el (nnheader-max-head-length)
(nnheader-head-chop-length, nnheader-file-name-translation-alist)
(nnheader-directory-separator-character)
(nnheader-pathname-coding-system):
* lisp/gnus/nnmail.el (nnmail-pathname-coding-system)
(nnmail-active-file-coding-system):
* lisp/gnus/nnrss.el (nnrss-file-coding-system):
* lisp/gnus/nntp.el (nntp-record-commands):
* lisp/gnus/score-mode.el (gnus-score-edit-done-hook)
(gnus-score-mode-hook, gnus-score-menu-hook):
* lisp/mail/rfc2047.el (rfc2047-header-encoding-alist)
(rfc2047-allow-irregular-q-encoded-words)
(rfc2047-allow-incomplete-encoded-text):
* lisp/mh-e/mh-alias.el (mh-alias-system-aliases):
* lisp/mh-e/mh-e.el (mh-mail-header-separator, mh-x-mailer-string):
* lisp/mh-e/mh-scan.el (mh-scan-format-mh, mh-scan-format-nmh):
* lisp/net/pop3.el (pop3-password):
* lisp/play/animate.el (animate-n-steps):
* lisp/progmodes/cc-vars.el (c-old-style-variable-behavior):
Convert from defvar with leading * to defcustom.
; * lisp/cedet/semantic/lex.el: Comments.
* lisp/emulation/viper-init.el (viper-heading-end):
* lisp/gnus/mm-url.el (mm-url-html-entities):
* lisp/gnus/nnmaildir.el (nnmaildir-article-file-name):
* lisp/mh-e/mh-e.el (mh-invisible-header-fields-compiled):
* lisp/net/tramp-adb.el (tramp-adb-method): Remove leading * from doc.
* lisp/gnus/messcompat.el: Mark (pointless) file not for compilation.
(message-from-style, message-interactive, message-indentation-spaces)
(message-signature, message-signature-file):
Remove settings that match the defaults.
(message-setup-hook, message-mode-hook, message-default-headers)
(message-send-hook, message-send-mail-function):
Just use setq rather than redefining.
* lisp/gnus/nnrss.el (nnrss):
* lisp/mail/rfc2047.el (rfc2047):
* lisp/play/animate.el (animate): New custom groups.
---
lisp/cedet/semantic/bovine/el.el | 6 ++--
lisp/cedet/semantic/lex-spp.el | 6 ++--
lisp/cedet/semantic/lex.el | 6 ++--
lisp/cedet/semantic/symref.el | 8 +++--
lisp/cedet/semantic/wisent/comp.el | 14 +++++---
lisp/cedet/semantic/wisent/wisent.el | 5 +--
lisp/emulation/viper-init.el | 2 +-
lisp/gnus/gnus-agent.el | 6 ++--
lisp/gnus/gnus-group.el | 8 +++--
lisp/gnus/gnus-srvr.el | 12 ++++---
lisp/gnus/message.el | 10 ++++--
lisp/gnus/messcompat.el | 65 ++++++++--------------------------
lisp/gnus/mm-decode.el | 8 +++--
lisp/gnus/mm-url.el | 2 +-
lisp/gnus/mm-util.el | 6 ++--
lisp/gnus/mm-view.el | 6 ++--
lisp/gnus/mml.el | 10 +++---
lisp/gnus/nndraft.el | 8 +++--
lisp/gnus/nnheader.el | 37 ++++++++++++-------
lisp/gnus/nnmail.el | 12 ++++---
lisp/gnus/nnmaildir.el | 4 +--
lisp/gnus/nnrss.el | 12 +++++--
lisp/gnus/nntp.el | 6 ++--
lisp/gnus/score-mode.el | 22 +++++++-----
lisp/mail/rfc2047.el | 28 ++++++++++-----
lisp/mh-e/mh-alias.el | 8 +++--
lisp/mh-e/mh-e.el | 19 +++++-----
lisp/mh-e/mh-scan.el | 16 +++++----
lisp/net/pop3.el | 6 ++--
lisp/net/tramp-adb.el | 2 +-
lisp/play/animate.el | 10 ++++--
lisp/plstore.el | 8 +++--
lisp/progmodes/cc-vars.el | 8 +++--
33 files changed, 223 insertions(+), 163 deletions(-)
diff --git a/lisp/cedet/semantic/bovine/el.el b/lisp/cedet/semantic/bovine/el.el
index 6f41ba3..93796bd 100644
--- a/lisp/cedet/semantic/bovine/el.el
+++ b/lisp/cedet/semantic/bovine/el.el
@@ -149,8 +149,10 @@ compound strings."
(nth 1 form))
(t nil)))
-(defvar semantic-elisp-store-documentation-in-tag nil
- "*When non-nil, store documentation strings in the created tags.")
+(defcustom semantic-elisp-store-documentation-in-tag nil
+ "When non-nil, store documentation strings in the created tags."
+ :type 'boolean
+ :group 'semantic)
(defun semantic-elisp-do-doc (str)
"Return STR as a documentation string IF they are enabled."
diff --git a/lisp/cedet/semantic/lex-spp.el b/lisp/cedet/semantic/lex-spp.el
index fe90a04..b960e7a 100644
--- a/lisp/cedet/semantic/lex-spp.el
+++ b/lisp/cedet/semantic/lex-spp.el
@@ -1306,8 +1306,10 @@ where a valid symbol is 'system, or nil."
;;
;; These routines are for saving macro lists into an EIEIO persistent
;; file.
-(defvar semantic-lex-spp-macro-max-length-to-save 200
- "*Maximum length of an SPP macro before we opt to not save it.")
+(defcustom semantic-lex-spp-macro-max-length-to-save 200
+ "Maximum length of an SPP macro before we opt to not save it."
+ :type 'integer
+ :group 'semantic)
;;;###autoload
(defun semantic-lex-spp-table-write-slot-value (value)
diff --git a/lisp/cedet/semantic/lex.el b/lisp/cedet/semantic/lex.el
index c827fab..f8372e6 100644
--- a/lisp/cedet/semantic/lex.el
+++ b/lisp/cedet/semantic/lex.el
@@ -739,8 +739,10 @@ a LOCAL option.")
;; Stack of nested blocks.
(defvar semantic-lex-block-stack nil)
-;;(defvar semantic-lex-timeout 5
-;; "*Number of sections of lexing before giving up.")
+;;(defcustom semantic-lex-timeout 5
+;; "Number of sections of lexing before giving up."
+;; :type 'integer
+;; :group 'semantic)
(defsubst semantic-lex-debug-break (token)
"Break during lexical analysis at TOKEN."
diff --git a/lisp/cedet/semantic/symref.el b/lisp/cedet/semantic/symref.el
index 0c1fe7e..854b72f 100644
--- a/lisp/cedet/semantic/symref.el
+++ b/lisp/cedet/semantic/symref.el
@@ -76,10 +76,12 @@
(declare-function ede-up-directory "ede/files")
;;; Code:
-(defvar semantic-symref-tool 'detect
- "*The active symbol reference tool name.
+(defcustom semantic-symref-tool 'detect
+ "The active symbol reference tool name.
The tool symbol can be 'detect, or a symbol that is the name of
-a tool that can be used for symbol referencing.")
+a tool that can be used for symbol referencing."
+ :type 'symbol
+ :group 'semantic)
(make-variable-buffer-local 'semantic-symref-tool)
;;; TOOL SETUP
diff --git a/lisp/cedet/semantic/wisent/comp.el
b/lisp/cedet/semantic/wisent/comp.el
index 86058cf..3e46f35 100644
--- a/lisp/cedet/semantic/wisent/comp.el
+++ b/lisp/cedet/semantic/wisent/comp.el
@@ -187,8 +187,10 @@ If optional LEFT is non-nil insert spaces on left."
(defvar wisent-new-log-flag nil
"Non-nil means to start a new report.")
-(defvar wisent-verbose-flag nil
- "*Non-nil means to report verbose information on generated parser.")
+(defcustom wisent-verbose-flag nil
+ "Non-nil means to report verbose information on generated parser."
+ :group 'wisent
+ :type 'boolean)
(defun wisent-toggle-verbose-flag ()
"Toggle whether to report verbose information on generated parser."
@@ -2261,12 +2263,14 @@ tables so that there is no longer a conflict."
(setq i (1+ i))))
rrc-count))
-(defvar wisent-expected-conflicts nil
- "*If non-nil suppress the warning about shift/reduce conflicts.
+(defcustom wisent-expected-conflicts nil
+ "If non-nil suppress the warning about shift/reduce conflicts.
It is a decimal integer N that says there should be no warning if
there are N shift/reduce conflicts and no reduce/reduce conflicts. A
warning is given if there are either more or fewer conflicts, or if
-there are any reduce/reduce conflicts.")
+there are any reduce/reduce conflicts."
+ :group 'wisent
+ :type '(choice (const nil) integer))
(defun wisent-total-conflicts ()
"Report the total number of conflicts."
diff --git a/lisp/cedet/semantic/wisent/wisent.el
b/lisp/cedet/semantic/wisent/wisent.el
index 9eab860..2b22573 100644
--- a/lisp/cedet/semantic/wisent/wisent.el
+++ b/lisp/cedet/semantic/wisent/wisent.el
@@ -127,8 +127,9 @@ POSITIONS are available."
(apply #'max (mapcar #'cdr pl))))))
;;; Reporting
-(defvar wisent-parse-verbose-flag nil
- "*Non-nil means to issue more messages while parsing.")
+(defcustom wisent-parse-verbose-flag nil
+ "Non-nil means to issue more messages while parsing."
+ :type 'boolean)
(defun wisent-parse-toggle-verbose-flag ()
"Toggle whether to issue more messages while parsing."
diff --git a/lisp/emulation/viper-init.el b/lisp/emulation/viper-init.el
index c1e7662..ef66236 100644
--- a/lisp/emulation/viper-init.el
+++ b/lisp/emulation/viper-init.el
@@ -781,7 +781,7 @@ Related buffers can be cycled through via :R and :P
commands."
"address@hidden \\|" ;
texinfo
")\n\n[ \t\n]*\\|" ; lisp
"\\.\\s-*$") ; prolog
- "*Regexps to end Headings/Sections. Used by [].")
+ "Regexps to end Headings/Sections. Used by [].")
;; These two vars control the interaction of jumps performed by ' and `.
diff --git a/lisp/gnus/gnus-agent.el b/lisp/gnus/gnus-agent.el
index 364fb7f..e6356b1 100644
--- a/lisp/gnus/gnus-agent.el
+++ b/lisp/gnus/gnus-agent.el
@@ -2633,8 +2633,10 @@ General format specifiers can also be used. See Info
node
"\C-c\C-i" gnus-info-find-node
"\C-c\C-b" gnus-bug))
-(defvar gnus-category-menu-hook nil
- "*Hook run after the creation of the menu.")
+(defcustom gnus-category-menu-hook nil
+ "Hook run after the creation of the menu."
+ :group 'gnus-agent
+ :type 'hook)
(defun gnus-category-make-menu-bar ()
(gnus-turn-off-edit-menu 'category)
diff --git a/lisp/gnus/gnus-group.el b/lisp/gnus/gnus-group.el
index ed114c2..813d9b6 100644
--- a/lisp/gnus/gnus-group.el
+++ b/lisp/gnus/gnus-group.el
@@ -448,10 +448,12 @@ used when no prefix argument is given to
`gnus-group-jump-to-group'."
(repeat (cons (integer :tag "Argument")
(string :tag "Prompt string")))))
-(defvar gnus-group-listing-limit 1000
- "*A limit of the number of groups when listing.
+(defcustom gnus-group-listing-limit 1000
+ "A limit of the number of groups when listing.
If the number of groups is larger than the limit, list them in a
-simple manner.")
+simple manner."
+ :group 'gnus-group-listing
+ :type 'integer)
;;; Internal variables
diff --git a/lisp/gnus/gnus-srvr.el b/lisp/gnus/gnus-srvr.el
index 30c7deb..aa76a5f 100644
--- a/lisp/gnus/gnus-srvr.el
+++ b/lisp/gnus/gnus-srvr.el
@@ -109,8 +109,10 @@ If nil, a faster, but more primitive, buffer is used
instead."
(defvar gnus-server-mode-map)
-(defvar gnus-server-menu-hook nil
- "*Hook run after the creation of the server mode menu.")
+(defcustom gnus-server-menu-hook nil
+ "Hook run after the creation of the server mode menu."
+ :type 'hook
+ :group 'gnus-server)
(defun gnus-server-make-menu-bar ()
(gnus-turn-off-edit-menu 'server)
@@ -684,8 +686,10 @@ The following commands are available:
;;; Browse Server Mode
;;;
-(defvar gnus-browse-menu-hook nil
- "*Hook run after the creation of the browse mode menu.")
+(defcustom gnus-browse-menu-hook nil
+ "Hook run after the creation of the browse mode menu."
+ :group 'gnus-server
+ :type 'hook)
(defcustom gnus-browse-subscribe-newsgroup-method
'gnus-subscribe-alphabetically
diff --git a/lisp/gnus/message.el b/lisp/gnus/message.el
index c3bdfdb..c052cdf 100644
--- a/lisp/gnus/message.el
+++ b/lisp/gnus/message.el
@@ -1372,8 +1372,8 @@ If a function email is passed as the argument."
message-dont-reply-to-names
(gmm-regexp-concat message-dont-reply-to-names)))
-(defvar message-shoot-gnksa-feet nil
- "*A list of GNKSA feet you are allowed to shoot.
+(defcustom message-shoot-gnksa-feet nil
+ "A list of GNKSA feet you are allowed to shoot.
Gnus gives you all the opportunity you could possibly want for
shooting yourself in the foot. Also, Gnus allows you to shoot the
feet of Good Net-Keeping Seal of Approval. The following are foot
@@ -1383,7 +1383,11 @@ candidates:
`multiple-copies' Allow you to post multiple copies;
`cancel-messages' Allow you to cancel or supersede messages from
your other email addresses;
-`canlock-verify' Allow you to cancel messages without verifying canlock.")
+`canlock-verify' Allow you to cancel messages without verifying canlock."
+ :group 'message
+ :type '(set (const empty-article) (const quoted-text-only)
+ (const multiple-copies) (const cancel-messages)
+ (const canlock-verify)))
(defsubst message-gnksa-enable-p (feature)
(or (not (listp message-shoot-gnksa-feet))
diff --git a/lisp/gnus/messcompat.el b/lisp/gnus/messcompat.el
index 6eadf2a..2b658bc 100644
--- a/lisp/gnus/messcompat.el
+++ b/lisp/gnus/messcompat.el
@@ -34,58 +34,21 @@
(require 'sendmail)
-(defvar message-from-style mail-from-style
- "*Specifies how \"From\" headers look.
-
-If nil, they contain just the return address like:
- address@hidden
-If `parens', they look like:
- address@hidden (Elvis Parsley)
-If `angles', they look like:
- Elvis Parsley <address@hidden>
-
-Otherwise, most addresses look like `angles', but they look like
-`parens' if `angles' would need quoting and `parens' would not.")
-
-(defvar message-interactive mail-interactive
- "Non-nil means when sending a message wait for and display errors.
-nil means let mailer mail back a message to report errors.")
-
-(defvar message-setup-hook mail-setup-hook
- "Normal hook, run each time a new outgoing message is initialized.
-The function `message-setup' runs this hook.")
-
-(if (boundp 'mail-mode-hook)
- (defvar message-mode-hook mail-mode-hook
- "Hook run in message mode buffers."))
-
-(defvar message-indentation-spaces mail-indentation-spaces
- "*Number of spaces to insert at the beginning of each cited line.
-Used by `message-yank-original' via `message-yank-cite'.")
-
-(defvar message-signature mail-signature
- "*String to be inserted at the end of the message buffer.
-If t, the `message-signature-file' file will be inserted instead.
-If a function, the result from the function will be used instead.
-If a form, the result from the form will be used instead.")
-
-;; Deleted the autoload cookie because this crashes in loaddefs.el.
-(defvar message-signature-file mail-signature-file
- "*File containing the text inserted at end of the message buffer.")
-
-(defvar message-default-headers mail-default-headers
- "*A string containing header lines to be inserted in outgoing messages.
-It is inserted before you edit the message, so you can edit or delete
-these lines.")
-
-(defvar message-send-hook mail-send-hook
- "Hook run before sending messages.")
-
-(defvar message-send-mail-function send-mail-function
- "Function to call to send the current buffer as mail.
-The headers should be delimited by a line whose contents match the
-variable `mail-header-separator'.")
+;(setq message-from-style mail-from-style)
+;(setq message-interactive mail-interactive)
+(setq message-setup-hook mail-setup-hook)
+(setq message-mode-hook mail-mode-hook)
+;(setq message-indentation-spaces mail-indentation-spaces)
+;(setq message-signature mail-signature)
+;(setq message-signature-file mail-signature-file)
+(setq message-default-headers mail-default-headers)
+(setq message-send-hook mail-send-hook)
+(setq message-send-mail-function send-mail-function)
(provide 'messcompat)
;;; messcompat.el ends here
+
+;; Local Variables:
+;; no-byte-compile: t
+;; End:
diff --git a/lisp/gnus/mm-decode.el b/lisp/gnus/mm-decode.el
index f45337d..744474c 100644
--- a/lisp/gnus/mm-decode.el
+++ b/lisp/gnus/mm-decode.el
@@ -425,13 +425,15 @@ functions), `mm-file-name-delete-whitespace',
:group 'mime-display)
-(defvar mm-path-name-rewrite-functions nil
- "*List of functions for rewriting the full file names of MIME parts.
+(defcustom mm-path-name-rewrite-functions nil
+ "List of functions for rewriting the full file names of MIME parts.
This is used when viewing parts externally, and is meant for
transforming the absolute name so that non-compliant programs can find
the file where it's saved.
-Each function takes a file name as input and returns a file name.")
+Each function takes a file name as input and returns a file name."
+ :type '(repeat function)
+ :group 'mime-display)
(defvar mm-file-name-replace-whitespace nil
"String used for replacing whitespace characters; default is `\"_\"'.")
diff --git a/lisp/gnus/mm-url.el b/lisp/gnus/mm-url.el
index 8e05605..cbea134 100644
--- a/lisp/gnus/mm-url.el
+++ b/lisp/gnus/mm-url.el
@@ -245,7 +245,7 @@ Likely values are `wget', `w3m', `lynx' and `curl'."
;; To be done
;; (shy . ????) ; soft hyphen
)
- "*An assoc list of entity names and how to actually display them.")
+ "An assoc list of entity names and how to actually display them.")
(defconst mm-url-unreserved-chars
'(
diff --git a/lisp/gnus/mm-util.el b/lisp/gnus/mm-util.el
index c0f8742..adf2fda 100644
--- a/lisp/gnus/mm-util.el
+++ b/lisp/gnus/mm-util.el
@@ -420,7 +420,7 @@ variable is set, it overrides the default priority."
Setting it to nil is useful on Emacsen supporting Unicode if sending
mail with multiple parts is preferred to sending a Unicode one.")
-(defvar mm-extra-numeric-entities
+(defcustom mm-extra-numeric-entities
(mapcar
(lambda (item)
(cons (car item) (mm-ucs-to-char (cdr item))))
@@ -433,7 +433,9 @@ mail with multiple parts is preferred to sending a Unicode
one.")
(#x9C . #x0153) (#x9E . #x017E) (#x9F . #x0178)))
"*Alist of extra numeric entities and characters other than ISO 10646.
This table is used for decoding extra numeric entities to characters,
-like \"€\" to the euro sign, mainly in html messages.")
+like \"€\" to the euro sign, mainly in html messages."
+ :type '(alist :key-type character :value-type character)
+ :group 'mime)
;;; Internal variables:
diff --git a/lisp/gnus/mm-view.el b/lisp/gnus/mm-view.el
index c62ea95..e934f8b 100644
--- a/lisp/gnus/mm-view.el
+++ b/lisp/gnus/mm-view.el
@@ -198,8 +198,10 @@
(delete-region ,(point-min-marker)
,(point-max-marker)))))))))
-(defvar mm-w3m-standalone-supports-m17n-p 'undecided
- "*T means the w3m command supports the m17n feature.")
+(defcustom mm-w3m-standalone-supports-m17n-p 'undecided
+ "T means the w3m command supports the m17n feature."
+ :type '(choice (const nil) (const t) (other :tag "detect" undecided))
+ :group 'mime-display)
(defun mm-w3m-standalone-supports-m17n-p ()
"Say whether the w3m command supports the m17n feature."
diff --git a/lisp/gnus/mml.el b/lisp/gnus/mml.el
index 665a943..6105f79 100644
--- a/lisp/gnus/mml.el
+++ b/lisp/gnus/mml.el
@@ -148,17 +148,19 @@ is called. FUNCTION is a Lisp function which is called
with the MML
handle to tweak the part.")
(defvar mml-externalize-attachments nil
- "*If non-nil, local-file attachments are generated as external parts.")
+ "If non-nil, local-file attachments are generated as external parts.")
-(defvar mml-generate-multipart-alist nil
- "*Alist of multipart generation functions.
+(defcustom mml-generate-multipart-alist nil
+ "Alist of multipart generation functions.
Each entry has the form (NAME . FUNCTION), where
NAME is a string containing the name of the part (without the
leading \"/multipart/\"),
FUNCTION is a Lisp function which is called to generate the part.
The Lisp function has to supply the appropriate MIME headers and the
-contents of this part.")
+contents of this part."
+ :group 'message
+ :type '(alist :key-type string :value-type function))
(defvar mml-syntax-table
(let ((table (copy-syntax-table emacs-lisp-mode-syntax-table)))
diff --git a/lisp/gnus/nndraft.el b/lisp/gnus/nndraft.el
index f10b6fa..0c887f0 100644
--- a/lisp/gnus/nndraft.el
+++ b/lisp/gnus/nndraft.el
@@ -43,10 +43,12 @@
"Where nndraft will store its files."
nnmh-directory)
-(defvar nndraft-required-headers '(Date)
- "*Headers to be generated when saving a draft message.
+(defcustom nndraft-required-headers '(Date)
+ "Headers to be generated when saving a draft message.
The headers in this variable and the ones in `message-required-headers'
-are generated if and only if they are also in `message-draft-headers'.")
+are generated if and only if they are also in `message-draft-headers'."
+ :type '(repeat sexp)
+ :group 'message-headers) ; FIXME wrong group
diff --git a/lisp/gnus/nnheader.el b/lisp/gnus/nnheader.el
index 191a908..6782229 100644
--- a/lisp/gnus/nnheader.el
+++ b/lisp/gnus/nnheader.el
@@ -63,18 +63,23 @@ they will keep on jabbering all the time."
:group 'gnus-server
:type 'boolean)
-(defvar nnheader-max-head-length 8192
- "*Max length of the head of articles.
+(defcustom nnheader-max-head-length 8192
+ "Max length of the head of articles.
Value is an integer, nil, or t. nil means read in chunks of a file
indefinitely until a complete head is found; t means always read the
entire file immediately, disregarding `nnheader-head-chop-length'.
Integer values will in effect be rounded up to the nearest multiple of
-`nnheader-head-chop-length'.")
-
-(defvar nnheader-head-chop-length 2048
- "*Length of each read operation when trying to fetch HEAD headers.")
+`nnheader-head-chop-length'."
+ :group 'gnus-article-various ; FIXME?
+ :type '(choice integer (const :tag "Read chunks" nil)
+ (const :tag "Read entire file" t)))
+
+(defcustom nnheader-head-chop-length 2048
+ "Length of each read operation when trying to fetch HEAD headers."
+ :group 'gnus-article-various ; FIXME?
+ :type 'integer)
(defvar nnheader-read-timeout
(if (string-match "windows-nt\\|os/2\\|cygwin"
@@ -99,7 +104,7 @@ Integer values will in effect be rounded up to the nearest
multiple of
"How long nntp should wait between checking for the end of output.
Shorter values mean quicker response, but are more CPU intensive.")
-(defvar nnheader-file-name-translation-alist
+(defcustom nnheader-file-name-translation-alist
(let ((case-fold-search t))
(cond
((string-match "windows-nt\\|os/2\\|cygwin"
@@ -111,15 +116,19 @@ Shorter values mean quicker response, but are more CPU
intensive.")
nil
'((?+ . ?-)))))
(t nil)))
- "*Alist that says how to translate characters in file names.
+ "Alist that says how to translate characters in file names.
For instance, if \":\" is invalid as a file character in file names
on your system, you could say something like:
-\(setq nnheader-file-name-translation-alist \\='((?: . ?_)))")
+\(setq nnheader-file-name-translation-alist \\='((?: . ?_)))"
+ :group 'gnus-article-various ; FIXME?
+ :type '(alist :key-type character :value-type character))
-(defvar nnheader-directory-separator-character
+(defcustom nnheader-directory-separator-character
(string-to-char (substring (file-name-as-directory ".") -1))
- "*A character used to a directory separator.")
+ "A character used as a directory separator."
+ :group 'gnus-article-various ; FIXME?
+ :type 'character)
(autoload 'nnmail-message-id "nnmail")
(autoload 'mail-position-on-field "sendmail")
@@ -865,8 +874,10 @@ without formatting."
(or (not (numberp gnus-verbose-backends))
(<= level gnus-verbose-backends)))
-(defvar nnheader-pathname-coding-system 'iso-8859-1
- "*Coding system for file name.")
+(defcustom nnheader-pathname-coding-system 'iso-8859-1
+ "Coding system for file name."
+ :group 'gnus-article-various ; FIXME?
+ :type 'coding-system)
(defun nnheader-group-pathname (group dir &optional file)
"Make file name for GROUP."
diff --git a/lisp/gnus/nnmail.el b/lisp/gnus/nnmail.el
index c85ea7a..65a92e9 100644
--- a/lisp/gnus/nnmail.el
+++ b/lisp/gnus/nnmail.el
@@ -601,8 +601,10 @@ using different case (i.e. address@hidden vs
address@hidden)."
mm-text-coding-system
"Coding system used in reading inbox")
-(defvar nnmail-pathname-coding-system nil
- "*Coding system for file name.")
+(defcustom nnmail-pathname-coding-system nil
+ "Coding system for file name."
+ :group 'nnmail-various
+ :type 'coding-system)
(defun nnmail-find-file (file)
"Insert FILE in server buffer safely."
@@ -670,8 +672,10 @@ nn*-request-list should have been called before calling
this function."
(forward-line 1))
group-assoc))
-(defvar nnmail-active-file-coding-system 'raw-text
- "*Coding system for active file.")
+(defcustom nnmail-active-file-coding-system 'raw-text
+ "Coding system for active file."
+ :group 'nnmail-various
+ :type 'coding-system)
(defun nnmail-save-active (group-assoc file-name)
"Save GROUP-ASSOC in ACTIVE-FILE."
diff --git a/lisp/gnus/nnmaildir.el b/lisp/gnus/nnmaildir.el
index cebdc95..21c8375 100644
--- a/lisp/gnus/nnmaildir.el
+++ b/lisp/gnus/nnmaildir.el
@@ -125,8 +125,8 @@ SUFFIX should start with \":2,\"."
(concat ":2," new-flags)))
(defvar nnmaildir-article-file-name nil
- "*The filename of the most recently requested article. This variable is set
-by nnmaildir-request-article.")
+ "The filename of the most recently requested article.
+This variable is set by `nnmaildir-request-article'.")
;; The filename of the article being moved/copied:
(defvar nnmaildir--file nil)
diff --git a/lisp/gnus/nnrss.el b/lisp/gnus/nnrss.el
index 6168e5a..68dabcb 100644
--- a/lisp/gnus/nnrss.el
+++ b/lisp/gnus/nnrss.el
@@ -39,6 +39,10 @@
(require 'mml)
(require 'xml)
+(defgroup nnrss nil
+ "RSS access for Gnus."
+ :group 'gnus)
+
(nnoo-declare nnrss)
(defvoo nnrss-directory (nnheader-concat gnus-directory "rss/")
@@ -86,14 +90,16 @@ The arguments are (ENTRY GROUP ARTICLE).
ENTRY is the record of the current headline. GROUP is the group name.
ARTICLE is the article number of the current headline.")
-(defvar nnrss-file-coding-system mm-universal-coding-system
- "*Coding system used when reading and writing files.
+(defcustom nnrss-file-coding-system mm-universal-coding-system
+ "Coding system used when reading and writing files.
If you run Gnus with various versions of Emacsen, the value of this
variable should be the coding system that all those Emacsen support.
Note that you have to regenerate all the nnrss groups if you change
the value. Moreover, you should be patient even if you are made to
read the same articles twice, that arises for the difference of the
-versions of xml.el.")
+versions of xml.el."
+ :group 'nnrss
+ :type 'coding-system)
(defvar nnrss-compatible-encoding-alist
(delq nil (mapcar (lambda (elem)
diff --git a/lisp/gnus/nntp.el b/lisp/gnus/nntp.el
index fa5f0e6..38e7c6e 100644
--- a/lisp/gnus/nntp.el
+++ b/lisp/gnus/nntp.el
@@ -252,8 +252,10 @@ update their active files often, this can help.")
;;; Internal variables.
(defvoo nntp-retrieval-in-progress nil)
-(defvar nntp-record-commands nil
- "*If non-nil, nntp will record all commands in the \"*nntp-log*\" buffer.")
+(defcustom nntp-record-commands nil
+ "If non-nil, nntp will record all commands in the \"*nntp-log*\" buffer."
+ :group 'nntp
+ :type 'boolean)
(defvar nntp-have-messaged nil)
diff --git a/lisp/gnus/score-mode.el b/lisp/gnus/score-mode.el
index 8413f22..5ae59c3 100644
--- a/lisp/gnus/score-mode.el
+++ b/lisp/gnus/score-mode.el
@@ -28,14 +28,20 @@
(require 'mm-util) ; for mm-universal-coding-system
(require 'gnus-util) ; for gnus-pp, gnus-run-mode-hooks
-(defvar gnus-score-edit-done-hook nil
- "*Hook run at the end of closing the score buffer.")
-
-(defvar gnus-score-mode-hook nil
- "*Hook run in score mode buffers.")
-
-(defvar gnus-score-menu-hook nil
- "*Hook run after creating the score mode menu.")
+(defcustom gnus-score-edit-done-hook nil
+ "Hook run at the end of closing the score buffer."
+ :group 'gnus-score
+ :type 'hook)
+
+(defcustom gnus-score-mode-hook nil
+ "Hook run in score mode buffers."
+ :group 'gnus-score
+ :type 'hook)
+
+(defcustom gnus-score-menu-hook nil
+ "Hook run after creating the score mode menu."
+ :group 'gnus-score
+ :type 'hook)
(defvar gnus-score-edit-exit-function nil
"Function run on exit from the score buffer.")
diff --git a/lisp/mail/rfc2047.el b/lisp/mail/rfc2047.el
index 4cb10e5..e636d61 100644
--- a/lisp/mail/rfc2047.el
+++ b/lisp/mail/rfc2047.el
@@ -37,14 +37,19 @@
(require 'rfc2045) ;; rfc2045-encode-string
(autoload 'mm-body-7-or-8 "mm-bodies")
-(defvar rfc2047-header-encoding-alist
+(defgroup rfc2047 nil
+ "RFC2047 messages."
+ :group 'mail
+ :prefix "rfc2047-")
+
+(defcustom rfc2047-header-encoding-alist
'(("Newsgroups" . nil)
("Followup-To" . nil)
("Message-ID" . nil)
("\\(Resent-\\)?\\(From\\|Cc\\|To\\|Bcc\\|\\(In-\\)?Reply-To\\|Sender\
\\|Mail-Followup-To\\|Mail-Copies-To\\|Approved\\)" . address-mime)
(t . mime))
- "*Header/encoding method alist.
+ "Header/encoding method alist.
The list is traversed sequentially. The keys can either be
header regexps or t.
@@ -56,7 +61,12 @@ The values can be:
fields (where quoted strings and comments must be treated separately);
4) a charset, in which case it will be encoded as that charset;
5) `default', in which case the field will be encoded as the rest
- of the article.")
+ of the article."
+ :type '(alist :key-type (choice regexp (const t))
+ :value-type (choice (const nil) (const mime)
+ (const address-mime)
+ coding-system
+ (const default))))
(defvar rfc2047-charset-encoding-alist
'((us-ascii . nil)
@@ -97,8 +107,9 @@ quoted-printable and base64 respectively.")
(defvar rfc2047-encode-encoded-words t
"Whether encoded words should be encoded again.")
-(defvar rfc2047-allow-irregular-q-encoded-words t
- "*Whether to decode irregular Q-encoded words.")
+(defcustom rfc2047-allow-irregular-q-encoded-words t
+ "Whether to decode irregular Q-encoded words."
+ :type 'boolean)
(eval-and-compile ;; Necessary to hard code them in `rfc2047-decode-region'.
(defconst rfc2047-encoded-word-regexp
@@ -864,14 +875,15 @@ is the standard but many mailers don't support it."
(defvar rfc2047-quote-decoded-words-containing-tspecials nil
"If non-nil, quote decoded words containing special characters.")
-(defvar rfc2047-allow-incomplete-encoded-text t
- "*Non-nil means allow incomplete encoded-text in successive encoded-words.
+(defcustom rfc2047-allow-incomplete-encoded-text t
+ "Non-nil means allow incomplete encoded-text in successive encoded-words.
Dividing of encoded-text in the place other than character boundaries
violates RFC2047 section 5, while we have a capability to decode it.
If it is non-nil, the decoder will decode B- or Q-encoding in each
encoded-word, concatenate them, and decode it by charset. Otherwise,
the decoder will fully decode each encoded-word before concatenating
-them.")
+them."
+ :type 'boolean)
(defun rfc2047-strip-backslashes-in-quoted-strings ()
"Strip backslashes in quoted strings. `\\\"' remains."
diff --git a/lisp/mh-e/mh-alias.el b/lisp/mh-e/mh-alias.el
index 1940234..968c33c 100644
--- a/lisp/mh-e/mh-alias.el
+++ b/lisp/mh-e/mh-alias.el
@@ -48,16 +48,18 @@
(define-key map " " 'self-insert-command)
map))
-(defvar mh-alias-system-aliases
+(defcustom mh-alias-system-aliases
'("/etc/nmh/MailAliases" "/etc/mh/MailAliases"
"/usr/lib/mh/MailAliases" "/usr/share/mailutils/mh/MailAliases"
"/etc/passwd")
- "*A list of system files which are a source of aliases.
+ "A list of system files which are a source of aliases.
If these files are modified, they are automatically reread. This list
need include only system aliases and the passwd file, since personal
alias files listed in your \"Aliasfile:\" MH profile component are
automatically included. You can update the alias list manually using
-\\[mh-alias-reload].")
+\\[mh-alias-reload]."
+ :type '(repeat file)
+ :group 'mh-alias)
diff --git a/lisp/mh-e/mh-e.el b/lisp/mh-e/mh-e.el
index 85ed376..12c674d 100644
--- a/lisp/mh-e/mh-e.el
+++ b/lisp/mh-e/mh-e.el
@@ -317,8 +317,8 @@ This list will always include the current folder
`mh-current-folder'. This variable can be used by
`mh-after-commands-processed-hook'.")
-(defvar mh-mail-header-separator "--------"
- "*Line used by MH to separate headers from text in messages being composed.
+(defcustom mh-mail-header-separator "--------"
+ "Line used by MH to separate headers from text in messages being composed.
This variable should not be used directly in programs. Programs
should use `mail-header-separator' instead.
@@ -328,7 +328,9 @@ contexts, you may have to perform this initialization
yourself.
Do not make this a regular expression as it may be the argument
to `insert' and it is passed through `regexp-quote' before being
-used by functions like `re-search-forward'.")
+used by functions like `re-search-forward'."
+ :group 'mh-e ; FIXME?
+ :type 'string)
(defvar mh-sent-from-folder nil
"Folder of msg assoc with this letter.")
@@ -385,11 +387,12 @@ This is the original map that is stored when the folder is
narrowed.")
(make-variable-buffer-local 'mh-thread-scan-line-map-stack)
-(defvar mh-x-mailer-string nil
- "*String containing the contents of the X-Mailer header field.
+(defcustom mh-x-mailer-string nil
+ "String containing the contents of the X-Mailer header field.
If nil, this variable is initialized to show the version of MH-E,
-Emacs, and MH the first time a message is composed.")
-
+Emacs, and MH the first time a message is composed."
+ :group 'mh-e ; FIXME?
+ :type '(choice (const :tag "Default" nil) string))
;;; MH-E Entry Points
@@ -2860,7 +2863,7 @@ update SF #1916032 (see URL
:package-version '(MH-E . "8.0"))
(defvar mh-invisible-header-fields-compiled nil
- "*Regexp matching lines in a message header that are not to be shown.
+ "Regexp matching lines in a message header that are not to be shown.
Do not alter this variable directly. Instead, customize
`mh-invisible-header-fields-default' checking for fields normally
hidden that you wish to display, and add extra entries to hide in
diff --git a/lisp/mh-e/mh-scan.el b/lisp/mh-e/mh-scan.el
index 8241e6e..a04ca88 100644
--- a/lisp/mh-e/mh-scan.el
+++ b/lisp/mh-e/mh-scan.el
@@ -44,7 +44,7 @@
;; want to change the column of the notations, use the `mh-set-cmd-note'
;; function.
-(defvar mh-scan-format-mh
+(defcustom mh-scan-format-mh
(concat
"%4(msg)"
"%<(cur)+%| %>"
@@ -58,7 +58,7 @@
"%<(mymbox{from})%<{to}To:%14(friendly{to})%>%>"
"%<(zero)%17(friendly{from})%> "
"%{subject}%<{body}<<%{body}%>")
- "*Scan format string for MH.
+ "Scan format string for MH.
This string is passed to the scan program via the -format
argument. This format is identical to the default except that
additional hints for fontification have been added to the fifth
@@ -68,9 +68,11 @@ The values of the fifth column, in priority order, are:
\"-\" if
the message has been replied to, t if an address on the To: line
matches one of the mailboxes of the current user, \"c\" if the Cc:
line matches, \"b\" if the Bcc: line matches, and \"n\" if a
-non-empty Newsgroups: header is present.")
+non-empty Newsgroups: header is present."
+ :group 'mh-scan-line-formats
+ :type 'string)
-(defvar mh-scan-format-nmh
+(defcustom mh-scan-format-nmh
(concat
"%4(msg)"
"%<(cur)+%| %>"
@@ -84,7 +86,7 @@ non-empty Newsgroups: header is present.")
"%<(mymbox{from})%<{to}To:%14(decode(friendly{to}))%>%>"
"%<(zero)%17(decode(friendly{from}))%> "
"%(decode{subject})%<{body}<<%{body}%>")
- "*Scan format string for nmh.
+ "Scan format string for nmh.
This string is passed to the scan program via the -format arg.
This format is identical to the default except that additional
hints for fontification have been added to the fifth
@@ -94,7 +96,9 @@ The values of the fifth column, in priority order, are: \"-\"
if
the message has been replied to, t if an address on the To: field
matches one of the mailboxes of the current user, \"c\" if the Cc:
field matches, \"b\" if the Bcc: field matches, and \"n\" if a
-non-empty Newsgroups: field is present.")
+non-empty Newsgroups: field is present."
+ :group 'mh-scan-line-formats
+ :type 'string)
diff --git a/lisp/net/pop3.el b/lisp/net/pop3.el
index 589eeb3..d09c1d0 100644
--- a/lisp/net/pop3.el
+++ b/lisp/net/pop3.el
@@ -70,8 +70,10 @@
:group 'pop3)
;; Should this be customizable?
-(defvar pop3-password nil
- "*Password to use when connecting to POP server.")
+(defcustom pop3-password nil
+ "Password to use when connecting to POP server."
+ :type '(choice (const nil) string)
+ :group 'pop3)
(defcustom pop3-authentication-scheme 'pass
"POP3 authentication scheme.
diff --git a/lisp/net/tramp-adb.el b/lisp/net/tramp-adb.el
index f77e44e..649099e 100644
--- a/lisp/net/tramp-adb.el
+++ b/lisp/net/tramp-adb.el
@@ -52,7 +52,7 @@ It is used for TCP/IP devices."
;;;###tramp-autoload
(defconst tramp-adb-method "adb"
- "*When this method name is used, forward all calls to Android Debug Bridge.")
+ "When this method name is used, forward all calls to Android Debug Bridge.")
;;;###tramp-autoload
(defcustom tramp-adb-prompt
diff --git a/lisp/play/animate.el b/lisp/play/animate.el
index 66f3d10..cdcee62 100644
--- a/lisp/play/animate.el
+++ b/lisp/play/animate.el
@@ -44,6 +44,11 @@
;;; in the string when the whole string finally reaches its
;;; specified position.
+(defgroup animate nil
+ "Make text dance."
+ :group 'games
+ :prefix "animate-")
+
(defun animate-initialize (string vpos hpos)
(let ((characters nil))
(dotimes (i (length string))
@@ -88,8 +93,9 @@
(unless (eolp) (delete-char 1))
(insert-char char 1))
-(defvar animate-n-steps 10
-"*Number of steps `animate-string' will place a char before its last
position.")
+(defcustom animate-n-steps 10
+ "Number of steps `animate-string' will place a char before its last
position."
+ :type 'integer)
(defvar animation-buffer-name nil
"String naming the default buffer for animations.
diff --git a/lisp/plstore.el b/lisp/plstore.el
index 62c50c0..01bdd14 100644
--- a/lisp/plstore.el
+++ b/lisp/plstore.el
@@ -99,10 +99,12 @@ If neither t nor nil, doesn't ask user."
(const :tag "Don't ask" silent))
:group 'plstore)
-(defvar plstore-encrypt-to nil
- "*Recipient(s) used for encrypting secret entries.
+(defcustom plstore-encrypt-to nil
+ "Recipient(s) used for encrypting secret entries.
May either be a string or a list of strings. If it is nil,
-symmetric encryption will be used.")
+symmetric encryption will be used."
+ :type '(choice (const nil) (repeat :tag "Recipient(s)" string))
+ :group 'plstore)
(put 'plstore-encrypt-to 'safe-local-variable
(lambda (val)
diff --git a/lisp/progmodes/cc-vars.el b/lisp/progmodes/cc-vars.el
index dcfa89c..f03aec2 100644
--- a/lisp/progmodes/cc-vars.el
+++ b/lisp/progmodes/cc-vars.el
@@ -1499,8 +1499,8 @@ This variable only has effect in XEmacs."
:type 'boolean
:group 'c)
-(defvar c-old-style-variable-behavior nil
- "*Enables the old style variable behavior when non-nil.
+(defcustom c-old-style-variable-behavior nil
+ "Enables the old style variable behavior when non-nil.
Normally the values of the style variables will override the style
settings specified by the variables `c-default-style' and
@@ -1513,7 +1513,9 @@ It's believed that despite this change, the new behavior
will still
produce the same results for most old CC Mode configurations, since
all style variables are per default set in a special non-override
state. Set this variable only if your configuration has stopped
-working due to this change.")
+working due to this change."
+ :type 'boolean
+ :group 'c)
(define-widget 'c-extra-types-widget 'radio
"Internal CC Mode widget for the `*-font-lock-extra-types' variables."
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Emacs-diffs] master b27c670: Leading "*" in the doc of defvars is long obsolete.,
Glenn Morris <=