diff options
author | Chong Yidong <cyd@gnu.org> | 2012-04-09 21:05:48 +0800 |
---|---|---|
committer | Chong Yidong <cyd@gnu.org> | 2012-04-09 21:05:48 +0800 |
commit | fb7ada5f94a71d73bf6cfad5cc87fe7fb26125a5 (patch) | |
tree | eba43d1fa2427a77f1f6b1468838426b33ea5973 /lisp | |
parent | a18ecafa99e7e7c3caa35ed68dd8a7b9b5d2b8e3 (diff) | |
download | emacs-fb7ada5f94a71d73bf6cfad5cc87fe7fb26125a5.tar.gz |
Remove * characters from the front of variable docstrings.
Diffstat (limited to 'lisp')
169 files changed, 1194 insertions, 1194 deletions
diff --git a/lisp/allout-widgets.el b/lisp/allout-widgets.el index 86d567bcdde..16420d8af27 100644 --- a/lisp/allout-widgets.el +++ b/lisp/allout-widgets.el @@ -153,7 +153,7 @@ See `allout-widgets-mode' for allout widgets mode features." ) ;; ;;;_ = allout-widgets-allow-unruly-edits ;; (defcustom allout-widgets-allow-unruly-edits nil -;; "*Control whether manual edits are restricted to maintain outline integrity. +;; "Control whether manual edits are restricted to maintain outline integrity. ;; When nil, manual edits must either be within an item's body or encompass ;; one or more items completely - eg, killing topics as entities, rather than @@ -203,21 +203,21 @@ See `allout-widgets-mode' for allout widgets mode features." ;;;_ = allout-widgets-item-image-properties-emacs (defcustom allout-widgets-item-image-properties-emacs '(:ascent center :mask (heuristic t)) - "*Default properties item widget images in mainline Emacs." + "Default properties item widget images in mainline Emacs." :version "24.1" :type 'plist :group 'allout-widgets) ;;;_ = allout-widgets-item-image-properties-xemacs (defcustom allout-widgets-item-image-properties-xemacs nil - "*Default properties item widget images in XEmacs." + "Default properties item widget images in XEmacs." :version "24.1" :type 'plist :group 'allout-widgets) ;;;_ . Developer ;;;_ = allout-widgets-run-unit-tests-on-load (defcustom allout-widgets-run-unit-tests-on-load nil - "*When non-nil, unit tests will be run at end of loading allout-widgets. + "When non-nil, unit tests will be run at end of loading allout-widgets. Generally, allout widgets code developers are the only ones who'll want to set this. @@ -232,7 +232,7 @@ See `allout-widgets-run-unit-tests' to see what's run." :group 'allout-widgets-developer) ;;;_ = allout-widgets-time-decoration-activity (defcustom allout-widgets-time-decoration-activity nil - "*Retain timing info of the last cooperative redecoration. + "Retain timing info of the last cooperative redecoration. The details are retained as the value of `allout-widgets-last-decoration-timing'. @@ -244,7 +244,7 @@ set this." :group 'allout-widgets-developer) ;;;_ = allout-widgets-hook-error-post-time 0 (defcustom allout-widgets-hook-error-post-time 0 - "*Amount of time to sit showing hook error messages. + "Amount of time to sit showing hook error messages. 0 is minimal, or nil to not post to the message area. @@ -254,7 +254,7 @@ This is for debugging purposes." :group 'allout-widgets-developer) ;;;_ = allout-widgets-maintain-tally nil (defcustom allout-widgets-maintain-tally nil - "*If non-nil, maintain a collection of widgets, `allout-widgets-tally'. + "If non-nil, maintain a collection of widgets, `allout-widgets-tally'. This is for debugging purposes. @@ -290,7 +290,7 @@ The number varies according to the evanescence of objects on a (format ":%s" (hash-table-count allout-widgets-tally)))) ;;;_ = allout-widgets-track-decoration nil (defcustom allout-widgets-track-decoration nil - "*If non-nil, show cursor position of each item decoration. + "If non-nil, show cursor position of each item decoration. This is for debugging purposes, and generally set at need in a buffer rather than as a prevailing configuration \(but it's handy @@ -416,7 +416,7 @@ onto the front.") ;;;_ , Widget-specific outline text format ;;;_ = allout-escaped-prefix-regexp (defvar allout-escaped-prefix-regexp "" - "*Regular expression for body text that would look like an item prefix if + "Regular expression for body text that would look like an item prefix if not altered with an escape sequence.") (make-variable-buffer-local 'allout-escaped-prefix-regexp) ;;;_ , Widget element formatting diff --git a/lisp/allout.el b/lisp/allout.el index 3eed3c7d23e..4883e4244a8 100644 --- a/lisp/allout.el +++ b/lisp/allout.el @@ -945,7 +945,7 @@ case the value of `allout-default-layout' is used.") ;;;_ : Topic header format ;;;_ = allout-regexp (defvar allout-regexp "" - "*Regular expression to match the beginning of a heading line. + "Regular expression to match the beginning of a heading line. Any line whose beginning matches this regexp is considered a heading. This var is set according to the user configuration vars @@ -965,7 +965,7 @@ and `allout-distinctive-bullets-string'.") (make-variable-buffer-local 'allout-bullets-string-len) ;;;_ = allout-depth-specific-regexp (defvar allout-depth-specific-regexp "" - "*Regular expression to match a heading line prefix for a particular depth. + "Regular expression to match a heading line prefix for a particular depth. This expression is used to search for depth-specific topic headers at depth 2 and greater. Use `allout-depth-one-regexp' @@ -978,7 +978,7 @@ topic prefix to be matched.") (make-variable-buffer-local 'allout-depth-specific-regexp) ;;;_ = allout-depth-one-regexp (defvar allout-depth-one-regexp "" - "*Regular expression to match a heading line prefix for depth one. + "Regular expression to match a heading line prefix for depth one. This var is set according to the user configuration vars by `set-allout-regexp'. It is prepared with format strings for two @@ -1403,10 +1403,10 @@ their settings before allout-mode was started." ,expr)) ;;;_ = allout-mode-hook (defvar allout-mode-hook nil - "*Hook that's run when allout mode starts.") + "Hook that's run when allout mode starts.") ;;;_ = allout-mode-deactivate-hook (defvar allout-mode-deactivate-hook nil - "*Hook that's run when allout mode ends.") + "Hook that's run when allout mode ends.") (define-obsolete-variable-alias 'allout-mode-deactivate-hook 'allout-mode-off-hook "24.1") ;;;_ = allout-exposure-category @@ -1414,7 +1414,7 @@ their settings before allout-mode was started." "Symbol for use as allout invisible-text overlay category.") ;;;_ = allout-exposure-change-hook (defvar allout-exposure-change-hook nil - "*Hook that's run after allout outline subtree exposure changes. + "Hook that's run after allout outline subtree exposure changes. It is run at the conclusion of `allout-flag-region'. @@ -1427,7 +1427,7 @@ Functions on the hook must take three arguments: This hook might be invoked multiple times by a single command.") ;;;_ = allout-structure-added-hook (defvar allout-structure-added-hook nil - "*Hook that's run after addition of items to the outline. + "Hook that's run after addition of items to the outline. Functions on the hook should take two arguments: @@ -1437,7 +1437,7 @@ Functions on the hook should take two arguments: This hook might be invoked multiple times by a single command.") ;;;_ = allout-structure-deleted-hook (defvar allout-structure-deleted-hook nil - "*Hook that's run after disciplined deletion of subtrees from the outline. + "Hook that's run after disciplined deletion of subtrees from the outline. Functions on the hook must take two arguments: @@ -1450,7 +1450,7 @@ specifically edits that native allout routines do not control. This hook might be invoked multiple times by a single command.") ;;;_ = allout-structure-shifted-hook (defvar allout-structure-shifted-hook nil - "*Hook that's run after shifting of items in the outline. + "Hook that's run after shifting of items in the outline. Functions on the hook should take two arguments: @@ -1463,12 +1463,12 @@ that native allout routines do not control. This hook might be invoked multiple times by a single command.") ;;;_ = allout-after-copy-or-kill-hook (defvar allout-after-copy-or-kill-hook nil - "*Hook that's run after copying outline text. + "Hook that's run after copying outline text. Functions on the hook should not require any arguments.") ;;;_ = allout-post-undo-hook (defvar allout-post-undo-hook nil - "*Hook that's run after undo activity. + "Hook that's run after undo activity. The item that's current when the hook is run *may* be the one that was affected by the undo. diff --git a/lisp/calc/calc-units.el b/lisp/calc/calc-units.el index dcbf845c371..9d2583085a2 100644 --- a/lisp/calc/calc-units.el +++ b/lisp/calc/calc-units.el @@ -302,7 +302,7 @@ (defvar math-additional-units nil - "*Additional units table for user-defined units. + "Additional units table for user-defined units. Must be formatted like `math-standard-units'. If you change this, be sure to set `math-units-table' to nil to ensure that the combined units table will be rebuilt.") diff --git a/lisp/calc/calc.el b/lisp/calc/calc.el index 41cdb491cfa..5224d1aa4f8 100644 --- a/lisp/calc/calc.el +++ b/lisp/calc/calc.el @@ -817,7 +817,7 @@ If nil, selections displayed but ignored.") Used by `calc-user-invocation'.") (defcalcmodevar calc-show-banner t - "*If non-nil, show a friendly greeting above the stack.") + "If non-nil, show a friendly greeting above the stack.") (defconst calc-local-var-list '(calc-stack calc-stack-top diff --git a/lisp/cedet/data-debug.el b/lisp/cedet/data-debug.el index d930a20fba5..03dca6ceccc 100644 --- a/lisp/cedet/data-debug.el +++ b/lisp/cedet/data-debug.el @@ -872,7 +872,7 @@ If PARENT is non-nil, it is somehow related as a parent to thing." "Keymap used in data-debug.") (defcustom data-debug-mode-hook nil - "*Hook run when data-debug starts." + "Hook run when data-debug starts." :group 'data-debug :type 'hook) diff --git a/lisp/cedet/pulse.el b/lisp/cedet/pulse.el index 746ee0b89af..8f367d918dc 100644 --- a/lisp/cedet/pulse.el +++ b/lisp/cedet/pulse.el @@ -77,7 +77,7 @@ this flag is ignored." (:background "#AAAA33")) (((class color) (background light)) (:background "#FFFFAA"))) - "*Face used at beginning of a highlight." + "Face used at beginning of a highlight." :group 'pulse) (defface pulse-highlight-face @@ -85,7 +85,7 @@ this flag is ignored." (:background "#AAAA33")) (((class color) (background light)) (:background "#FFFFAA"))) - "*Face used during a pulse for display. *DO NOT CUSTOMIZE* + "Face used during a pulse for display. *DO NOT CUSTOMIZE* Face used for temporary highlighting of tags for effect." :group 'pulse) diff --git a/lisp/cedet/semantic.el b/lisp/cedet/semantic.el index 0ed031019be..aeb5241b2d0 100644 --- a/lisp/cedet/semantic.el +++ b/lisp/cedet/semantic.el @@ -550,14 +550,14 @@ is requested." ) (defvar semantic-working-type 'percent - "*The type of working message to use when parsing. + "The type of working message to use when parsing. 'percent means we are doing a linear parse through the buffer. 'dynamic means we are reparsing specific tags.") (semantic-varalias-obsolete 'semantic-bovination-working-type 'semantic-working-type "23.2") (defvar semantic-minimum-working-buffer-size (* 1024 5) - "*The minimum size of a buffer before working messages are displayed. + "The minimum size of a buffer before working messages are displayed. Buffers smaller than this will parse silently. Buffers larger than this will display the working progress bar.") diff --git a/lisp/completion.el b/lisp/completion.el index ceb272fad6d..9c6cd60c96c 100644 --- a/lisp/completion.el +++ b/lisp/completion.el @@ -344,18 +344,18 @@ are automatically added to the completion database." :group 'completion) ;;(defvar *record-cmpl-statistics-p* nil -;; "*If non-nil, record completion statistics.") +;; "If non-nil, record completion statistics.") ;;(defvar *completion-auto-save-period* 1800 -;; "*The period in seconds to wait for emacs to be idle before autosaving +;; "The period in seconds to wait for emacs to be idle before autosaving ;;the completions. Default is a 1/2 hour.") (defvar completion-min-length 6 - "*The minimum length of a stored completion. + "The minimum length of a stored completion. DON'T CHANGE WITHOUT RECOMPILING ! This is used by macros.") (defvar completion-max-length 200 - "*The maximum length of a stored completion. + "The maximum length of a stored completion. DON'T CHANGE WITHOUT RECOMPILING ! This is used by macros.") (defvar completion-prefix-min-length 3 diff --git a/lisp/dframe.el b/lisp/dframe.el index d3356197a2b..2cdf4784eb0 100644 --- a/lisp/dframe.el +++ b/lisp/dframe.el @@ -157,22 +157,22 @@ selected frame and the focus will change to that frame." :type 'hook) (defvar dframe-track-mouse-function nil - "*A function to call when the mouse is moved in the given frame. + "A function to call when the mouse is moved in the given frame. Typically used to display info about the line under the mouse.") (make-variable-buffer-local 'dframe-track-mouse-function) (defvar dframe-help-echo-function nil - "*A function to call when help-echo is used in newer versions of Emacs. + "A function to call when help-echo is used in newer versions of Emacs. Typically used to display info about the line under the mouse.") (make-variable-buffer-local 'dframe-help-echo-function) (defvar dframe-mouse-click-function nil - "*A function to call when the mouse is clicked. + "A function to call when the mouse is clicked. Valid clicks are mouse 2, our double mouse 1.") (make-variable-buffer-local 'dframe-mouse-click-function) (defvar dframe-mouse-position-function nil - "*A function to call to position the cursor for a mouse click.") + "A function to call to position the cursor for a mouse click.") (make-variable-buffer-local 'dframe-mouse-position-function) (defvar dframe-power-click nil diff --git a/lisp/dos-w32.el b/lisp/dos-w32.el index d84e3737c91..071c7b71263 100644 --- a/lisp/dos-w32.el +++ b/lisp/dos-w32.el @@ -55,7 +55,7 @@ ("\\.tp[ulpw]$" . t) ; borland Pascal stuff ("[:/]tags$" . nil) ; emacs TAGS file ) - "*Alist for distinguishing text files from binary files. + "Alist for distinguishing text files from binary files. Each element has the form (REGEXP . TYPE), where REGEXP is matched against the file name, and TYPE is nil for text, t for binary.") @@ -283,7 +283,7 @@ filesystem mounted on drive Z:, FILESYSTEM could be \"Z:\"." ;;; Support for printing under DOS/Windows, see lpr.el and ps-print.el. (defvar direct-print-region-use-command-dot-com t - "*Control whether command.com is used to print on Windows 9x.") + "Control whether command.com is used to print on Windows 9x.") ;; Function to actually send data to the printer port. ;; Supports writing directly, and using various programs. diff --git a/lisp/emacs-lisp/chart.el b/lisp/emacs-lisp/chart.el index 19766feac5a..2e3abb2e9d3 100644 --- a/lisp/emacs-lisp/chart.el +++ b/lisp/emacs-lisp/chart.el @@ -82,7 +82,7 @@ Colors will be the background color.") Useful if new Emacs is used on B&W display.") (defcustom chart-face-use-pixmaps nil - "*Non-nil to use fancy pixmaps in the background of chart face colors." + "Non-nil to use fancy pixmaps in the background of chart face colors." :group 'eieio :type 'boolean) diff --git a/lisp/emacs-lisp/edebug.el b/lisp/emacs-lisp/edebug.el index 67ffd6d5d31..f47feebe5d2 100644 --- a/lisp/emacs-lisp/edebug.el +++ b/lisp/emacs-lisp/edebug.el @@ -3744,7 +3744,7 @@ This prints the value into current buffer." ;; FIXME eh? (defvar gud-inhibit-global-bindings - "*Non-nil means don't do global rebindings of C-x C-a subcommands.") + "Non-nil means don't do global rebindings of C-x C-a subcommands.") ;; Global GUD bindings for all emacs-lisp-mode buffers. (unless gud-inhibit-global-bindings diff --git a/lisp/emacs-lisp/eieio.el b/lisp/emacs-lisp/eieio.el index cdf7237b766..f1c1bf8965c 100644 --- a/lisp/emacs-lisp/eieio.el +++ b/lisp/emacs-lisp/eieio.el @@ -79,7 +79,7 @@ ;; (defvar eieio-hook nil - "*This hook is executed, then cleared each time `defclass' is called.") + "This hook is executed, then cleared each time `defclass' is called.") (defvar eieio-error-unsupported-class-tags nil "Non-nil to throw an error if an encountered tag is unsupported. @@ -87,7 +87,7 @@ This may prevent classes from CLOS applications from being used with EIEIO since EIEIO does not support all CLOS tags.") (defvar eieio-skip-typecheck nil - "*If non-nil, skip all slot typechecking. + "If non-nil, skip all slot typechecking. Set this to t permanently if a program is functioning well to get a small speed increase. This variable is also used internally to handle default setting for optimization purposes.") @@ -2044,7 +2044,7 @@ During executions, the list is first generated, then as each next method is called, the next method is popped off the stack.") (defvar eieio-pre-method-execution-hooks nil - "*Hooks run just before a method is executed. + "Hooks run just before a method is executed. The hook function must accept one argument, the list of forms about to be executed.") diff --git a/lisp/emacs-lisp/ert.el b/lisp/emacs-lisp/ert.el index 9cbe29bf322..ad5e20cb8a4 100644 --- a/lisp/emacs-lisp/ert.el +++ b/lisp/emacs-lisp/ert.el @@ -1405,7 +1405,7 @@ RESULT must be an `ert-test-result-with-condition'." ;;; Running tests in batch mode. (defvar ert-batch-backtrace-right-margin 70 - "*The maximum line length for printing backtraces in `ert-run-tests-batch'.") + "The maximum line length for printing backtraces in `ert-run-tests-batch'.") ;;;###autoload (defun ert-run-tests-batch (&optional selector) diff --git a/lisp/emacs-lisp/timer.el b/lisp/emacs-lisp/timer.el index b6b7c266263..87b6cceb24b 100644 --- a/lisp/emacs-lisp/timer.el +++ b/lisp/emacs-lisp/timer.el @@ -241,7 +241,7 @@ and idle timers such as are scheduled by `run-with-idle-timer'." "Third-to-last timer that was run.") (defvar timer-max-repeats 10 - "*Maximum number of times to repeat a timer, if many repeats are delayed. + "Maximum number of times to repeat a timer, if many repeats are delayed. Timer invocations can be delayed because Emacs is suspended or busy, or because the system's time changes. If such an occurrence makes it appear that many invocations are overdue, this variable controls diff --git a/lisp/emulation/viper-cmd.el b/lisp/emulation/viper-cmd.el index 68f40349454..111ce34dc1a 100644 --- a/lisp/emulation/viper-cmd.el +++ b/lisp/emulation/viper-cmd.el @@ -2119,7 +2119,7 @@ Undo previous insertion and inserts new." (defcustom viper-smart-suffix-list '("" "tex" "c" "cc" "C" "java" "el" "html" "htm" "xml" "pl" "flr" "P" "p" "h" "H") - "*List of suffixes that Viper tries to append to filenames ending with a `.'. + "List of suffixes that Viper tries to append to filenames ending with a `.'. This is useful when the current directory contains files with the same prefix and many different suffixes. Usually, only one of the suffixes represents an editable file. However, file completion will stop at the `.' diff --git a/lisp/emulation/viper-ex.el b/lisp/emulation/viper-ex.el index 3d538f1bd0d..acaedde3004 100644 --- a/lisp/emulation/viper-ex.el +++ b/lisp/emulation/viper-ex.el @@ -368,14 +368,14 @@ corresponding function symbol." (defvar viper-keep-reading-filename nil) (defcustom ex-cycle-other-window t - "*If t, :n and :b cycles through files and buffers in other window. + "If t, :n and :b cycles through files and buffers in other window. Then :N and :B cycles in the current window. If nil, this behavior is reversed." :type 'boolean :group 'viper-ex) (defcustom ex-cycle-through-non-files nil - "*Cycle through *scratch* and other buffers that don't visit any file." + "Cycle through *scratch* and other buffers that don't visit any file." :type 'boolean :group 'viper-ex) diff --git a/lisp/emulation/viper-init.el b/lisp/emulation/viper-init.el index f8ab5a1f805..76a8c410676 100644 --- a/lisp/emulation/viper-init.el +++ b/lisp/emulation/viper-init.el @@ -372,7 +372,7 @@ Use `M-x viper-set-expert-level' to change this.") (defconst viper-buffer-undo-list-mark 'viper) (defcustom viper-keep-point-on-undo nil - "*Non-nil means not to move point while undoing commands. + "Non-nil means not to move point while undoing commands. This style is different from Emacs and Vi. Try it to see if it better fits your working style." :type 'boolean @@ -403,7 +403,7 @@ delete the text being replaced, as in standard Vi." :group 'viper) (defcustom viper-replace-overlay-cursor-color "Red" - "*Cursor color when Viper is in Replace state." + "Cursor color when Viper is in Replace state." :type 'string :group 'viper) @@ -450,7 +450,7 @@ is non-nil." (defcustom viper-use-replace-region-delimiters (or (not (viper-has-face-support-p)) (and (featurep 'xemacs) (eq (viper-device-type) 'tty))) - "*If non-nil, Viper will always use `viper-replace-region-end-delimiter' and + "If non-nil, Viper will always use `viper-replace-region-end-delimiter' and `viper-replace-region-start-delimiter' to delimit replacement regions, even on color displays. By default, the delimiters are used only on TTYs." :type 'boolean @@ -519,7 +519,7 @@ 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. + "Key sequence separated by no more than this many milliseconds is viewed as a Vi-style macro, if such a macro 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 @@ -549,14 +549,14 @@ will make it hard to use Vi-style timeout macros." (viper-deflocalvar viper-auto-indent nil "") (defcustom viper-auto-indent nil - "*Enable autoindent, if t. + "Enable autoindent, if t. This is a buffer-local variable." :type 'boolean :group 'viper) (viper-deflocalvar viper-electric-mode t "") (defcustom viper-electric-mode t - "*If t, electrify Viper. + "If t, electrify Viper. Currently, this only electrifies auto-indentation, making it appropriate to the mode of the buffer. This means that auto-indentation will depart from standard Vi and will indent @@ -566,7 +566,7 @@ programs and LaTeX documents." :group 'viper) (defcustom viper-shift-width 8 - "*The value of the shiftwidth. + "The value of the shiftwidth. This determines the number of columns by which the Ctl-t moves the cursor in the Insert state." :type 'integer @@ -575,7 +575,7 @@ the Insert state." ;; Variables for repeating destructive commands (defcustom viper-keep-point-on-repeat t - "*If t, don't move point when repeating previous command. + "If t, don't move point when repeating previous command. This is useful for doing repeated changes with the '.' key. The user can change this to nil, if she likes when the cursor moves to a new place after repeating previous Vi command." @@ -668,18 +668,18 @@ to a new place after repeating previous Vi command." (defvar viper-s-forward nil) (defcustom viper-case-fold-search nil - "*If not nil, search ignores cases." + "If not nil, search ignores cases." :type 'boolean :group 'viper-search) (defcustom viper-re-search t - "*If not nil, search is regexp search, otherwise vanilla search." + "If not nil, search is regexp search, otherwise vanilla search." :type 'boolean :tag "Regexp Search" :group 'viper-search) (defcustom viper-search-scroll-threshold 2 - "*If search lands within this threshold from the window top/bottom, + "If search lands within this threshold from the window top/bottom, the window will be scrolled up or down appropriately, to reveal context. If you want Viper search to behave as usual in Vi, set this variable to a negative number." @@ -687,32 +687,32 @@ negative number." :group 'viper-search) (defcustom viper-re-query-replace t - "*If t then do regexp replace, if nil then do string replace." + "If t then do regexp replace, if nil then do string replace." :type 'boolean :tag "Regexp Query Replace" :group 'viper-search) (defcustom viper-re-replace t - "*If t, do regexp replace. nil means do string replace." + "If t, do regexp replace. nil means do string replace." :type 'boolean :tag "Regexp Replace" :group 'viper-search) (defcustom viper-parse-sexp-ignore-comments t - "*If t, `%' ignores the parentheses that occur inside comments." + "If t, `%' ignores the parentheses that occur inside comments." :type 'boolean :group 'viper) (viper-deflocalvar viper-ex-style-motion t "") (defcustom viper-ex-style-motion t - "*If t, the commands l,h do not cross lines, etc (Ex-style). + "If t, the commands l,h do not cross lines, etc (Ex-style). If nil, these commands cross line boundaries." :type 'boolean :group 'viper) (viper-deflocalvar viper-ex-style-editing t "") (defcustom viper-ex-style-editing t - "*If t, Ex-style behavior while editing in Vi command and insert states. + "If t, Ex-style behavior while editing in Vi command and insert states. `Backspace' and `Delete' don't cross line boundaries in insert. `X' and `x' can't delete characters across line boundary in Vi, etc. Note: this doesn't preclude `Backspace' and `Delete' from deleting characters @@ -724,32 +724,32 @@ If nil, the above commands can work across lines." (viper-deflocalvar viper-ESC-moves-cursor-back viper-ex-style-editing "") (defcustom viper-ESC-moves-cursor-back nil - "*If t, ESC moves cursor back when changing from insert to vi state. + "If t, ESC moves cursor back when changing from insert to vi state. If nil, the cursor stays where it was when ESC was hit." :type 'boolean :group 'viper) (viper-deflocalvar viper-delete-backwards-in-replace nil "") (defcustom viper-delete-backwards-in-replace nil - "*If t, DEL key will delete characters while moving the cursor backwards. + "If t, DEL key will delete characters while moving the cursor backwards. If nil, the cursor will move backwards without deleting anything." :type 'boolean :group 'viper) (defcustom viper-buffer-search-char nil - "*Key used for buffer-searching. Must be a character type, e.g., ?g." + "Key used for buffer-searching. Must be a character type, e.g., ?g." :type '(choice (const nil) character) :group 'viper-search) (defcustom viper-search-wrap-around t - "*If t, search wraps around." + "If t, search wraps around." :type 'boolean :tag "Search Wraps Around" :group 'viper-search) (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 that are considered to be related to the current buffer. Related buffers can be cycled through via :R and :P commands." :type 'boolean :group 'viper-misc) @@ -771,7 +771,7 @@ Related buffers can be cycled through via :R and :P commands." "^\\\\[sb][a-z]*{.*}\\s-*$\\|" ; latex "^@node\\|@table\\|^@m?enu\\|^@itemize\\|^@if\\|" ; texinfo "^.+:-") ; prolog - "*Regexps for Headings. Used by \[\[ and \]\].") + "Regexps for Headings. Used by \[\[ and \]\].") (defvar viper-heading-end (concat "^}\\|" ; C/C++ @@ -826,7 +826,7 @@ Related buffers can be cycled through via :R and :P commands." (defface viper-search '((((class color)) (:foreground "Black" :background "khaki")) (t (:underline t :stipple "gray3"))) - "*Face used to flash out the search pattern." + "Face used to flash out the search pattern." :group 'viper-highlighting) ;; An internal variable. Viper takes the face from here. (defvar viper-search-face 'viper-search @@ -838,7 +838,7 @@ this variable represents.") (defface viper-replace-overlay '((((class color)) (:foreground "Black" :background "darkseagreen2")) (t (:underline t :stipple "gray3"))) - "*Face for highlighting replace regions on a window display." + "Face for highlighting replace regions on a window display." :group 'viper-highlighting) ;; An internal variable. Viper takes the face from here. (defvar viper-replace-overlay-face 'viper-replace-overlay @@ -946,19 +946,19 @@ Should be set in `~/.viper' file." :group 'viper) (defcustom viper-vi-state-hook 'viper-restore-cursor-type - "*Hooks run just before the switch to Vi mode is completed." + "Hooks run just before the switch to Vi mode is completed." :type 'hook :group 'viper-hooks) (defcustom viper-insert-state-hook 'viper-set-insert-cursor-type - "*Hooks run just before the switch to Insert mode is completed." + "Hooks run just before the switch to Insert mode is completed." :type 'hook :group 'viper-hooks) (defcustom viper-replace-state-hook 'viper-restore-cursor-type - "*Hooks run just before the switch to Replace mode is completed." + "Hooks run just before the switch to Replace mode is completed." :type 'hook :group 'viper-hooks) (defcustom viper-emacs-state-hook 'viper-restore-cursor-type - "*Hooks run just before the switch to Emacs mode is completed." + "Hooks run just before the switch to Emacs mode is completed." :type 'hook :group 'viper-hooks) @@ -980,7 +980,7 @@ Should be set in `~/.viper' file." (setq cursor-type '(bar . 2)))) (defun viper-ESC-keyseq-timeout () - "*Key sequence beginning with ESC and separated by no more than this many milliseconds is considered to be generated by a keyboard function key. + "Key sequence beginning with ESC and separated by no more than this many milliseconds is considered to be generated by a keyboard function key. Setting this too high may slow down switching from insert to vi state. Setting this value too low will make it impossible to use function keys in insert mode on a dumb terminal." diff --git a/lisp/emulation/viper-keym.el b/lisp/emulation/viper-keym.el index 65638dfff3c..ad1e32b5546 100644 --- a/lisp/emulation/viper-keym.el +++ b/lisp/emulation/viper-keym.el @@ -48,19 +48,19 @@ ;;; Emacs keys in other states. (defcustom viper-want-emacs-keys-in-insert t - "*Set to nil if you want complete Vi compatibility in insert mode. + "Set to nil if you want complete Vi compatibility in insert mode. Complete compatibility with Vi is not recommended for power use of Viper." :type 'boolean :group 'viper) (defcustom viper-want-emacs-keys-in-vi t - "*Set to nil if you want complete Vi compatibility in Vi mode. + "Set to nil if you want complete Vi compatibility in Vi mode. Full Vi compatibility is not recommended for power use of Viper." :type 'boolean :group 'viper) (defcustom viper-no-multiple-ESC t - "*If true, multiple ESC in Vi mode will cause bell to ring. + "If true, multiple ESC in Vi mode will cause bell to ring. This is set to t on a windowing terminal and to 'twice on a dumb terminal (unless the user level is 1, 2, or 5). On a dumb terminal, this enables cursor keys and is generally more convenient, as terminals usually @@ -71,7 +71,7 @@ as is allowed by the 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, C-h gets bound to help-command; otherwise, C-h gets the usual Vi bindings." :type 'boolean :group 'viper) diff --git a/lisp/emulation/viper-mous.el b/lisp/emulation/viper-mous.el index 58d8fb45b92..eda1a7ec937 100644 --- a/lisp/emulation/viper-mous.el +++ b/lisp/emulation/viper-mous.el @@ -63,7 +63,7 @@ (defvar viper-current-frame-saved (selected-frame)) (defcustom viper-surrounding-word-function 'viper-surrounding-word - "*Function that determines what constitutes a word for clicking events. + "Function that determines what constitutes a word for clicking events. Takes two parameters: a COUNT, indicating how many words to return, and CLICK-COUNT, telling whether this is the first click, a double-click, or a triple-click." @@ -77,7 +77,7 @@ or a triple-click." mouse-track-multi-click-time double-click-time) 500) - "*Time interval in millisecond within which successive mouse clicks are + "Time interval in millisecond within which successive mouse clicks are considered related." :type 'integer :group 'viper-mouse) @@ -624,7 +624,7 @@ bindings in the Viper manual." (defcustom viper-mouse-search-key '(meta shift 1) - "*Key used to click-search in Viper. + "Key used to click-search in Viper. This must be a list that specifies the mouse button and modifiers. The supported modifiers are `meta', `shift', and `control'. For instance, `(meta shift 1)' means that holding the meta and shift @@ -640,7 +640,7 @@ This buffer may be different from the one where the click occurred." :group 'viper-mouse) (defcustom viper-mouse-insert-key '(meta shift 2) - "*Key used to click-insert in Viper. + "Key used to click-insert in Viper. Must be a list that specifies the mouse button and modifiers. The supported modifiers are `meta', `shift', and `control'. For instance, `(meta shift 2)' means that holding the meta and shift keys diff --git a/lisp/emulation/viper-util.el b/lisp/emulation/viper-util.el index cdeef733bc5..4afa379f389 100644 --- a/lisp/emulation/viper-util.el +++ b/lisp/emulation/viper-util.el @@ -1323,7 +1323,7 @@ sets the default value." (viper-update-syntax-classes)) (defcustom viper-syntax-preference 'reformed-vi - "*Syntax type characterizing Viper's alphanumeric symbols. + "Syntax type characterizing Viper's alphanumeric symbols. Affects movement and change commands that deal with Vi-style words. Works best when set in the hooks to various major modes. diff --git a/lisp/emulation/viper.el b/lisp/emulation/viper.el index 12c186e234e..9cf6c91265e 100644 --- a/lisp/emulation/viper.el +++ b/lisp/emulation/viper.el @@ -435,7 +435,7 @@ widget." view-mode vm-mode vm-summary-mode) - "*A list of major modes that should come up in Emacs state. + "A list of major modes that should come up in Emacs state. Normally, Viper would bring buffers up in Emacs state, unless the corresponding major mode has been placed on `viper-vi-state-mode-list' or `viper-insert-state-mode-list'. So, don't place a new mode on this list, @@ -451,7 +451,7 @@ unless it is coming up in a wrong Viper state." erc-mode eshell-mode shell-mode) - "*A list of major modes that should come up in Vi Insert state." + "A list of major modes that should come up in Vi Insert state." :type '(repeat symbol) :group 'viper-misc) diff --git a/lisp/epa.el b/lisp/epa.el index 3b9933f6984..58f4026a773 100644 --- a/lisp/epa.el +++ b/lisp/epa.el @@ -177,18 +177,18 @@ the separate window." (20 . ?G))) (defvar epa-protocol 'OpenPGP - "*The default protocol. + "The default protocol. The value can be either OpenPGP or CMS. You should bind this variable with `let', but do not set it globally.") (defvar epa-armor nil - "*If non-nil, epa commands create ASCII armored output. + "If non-nil, epa commands create ASCII armored output. You should bind this variable with `let', but do not set it globally.") (defvar epa-textmode nil - "*If non-nil, epa commands treat input files as text. + "If non-nil, epa commands treat input files as text. You should bind this variable with `let', but do not set it globally.") diff --git a/lisp/erc/erc-autoaway.el b/lisp/erc/erc-autoaway.el index 699c4e20552..ab429a12589 100644 --- a/lisp/erc/erc-autoaway.el +++ b/lisp/erc/erc-autoaway.el @@ -138,7 +138,7 @@ Related variables: `erc-public-away-p' and `erc-away-nickname'." (remove-hook 'erc-server-305-functions 'erc-autoaway-reset-indicators)))) (defcustom erc-autoaway-idle-method 'user - "*The method used to determine how long you have been idle. + "The method used to determine how long you have been idle. If 'user, the time of the last command sent to Emacs is used. If 'emacs, the idle time in Emacs is used. If 'irc, the time of the last IRC command is used. @@ -160,7 +160,7 @@ definitions of being idle." (set sym val)))) (defcustom erc-auto-set-away t - "*If non-nil, set away after `erc-autoaway-idle-seconds' seconds of idling. + "If non-nil, set away after `erc-autoaway-idle-seconds' seconds of idling. ERC autoaway mode can set you away when you idle, and set you no longer away when you type something. This variable controls whether you will be set away when you idle. See `erc-auto-discard-away' for @@ -169,7 +169,7 @@ the other half." :type 'boolean) (defcustom erc-auto-discard-away t - "*If non-nil, sending anything when away automatically discards away state. + "If non-nil, sending anything when away automatically discards away state. ERC autoaway mode can set you away when you idle, and set you no longer away when you type something. This variable controls whether you will be set no longer away when you type something. See @@ -179,13 +179,13 @@ See also `erc-autoaway-no-auto-discard-regexp'." :type 'boolean) (defcustom erc-autoaway-no-auto-discard-regexp "^/g?away.*$" - "*Input that matches this will not automatically discard away status. + "Input that matches this will not automatically discard away status. See `erc-auto-discard-away'." :group 'erc-autoaway :type 'regexp) (defcustom erc-autoaway-idle-seconds 1800 - "*Number of seconds after which ERC will set you automatically away. + "Number of seconds after which ERC will set you automatically away. If you are changing this variable using lisp instead of customizing it, you have to run `erc-autoaway-reestablish-idletimer' afterwards." :group 'erc-autoaway @@ -197,7 +197,7 @@ you have to run `erc-autoaway-reestablish-idletimer' afterwards." (defcustom erc-autoaway-message "I'm gone (autoaway after %i seconds of idletime)" - "*Message ERC will use when setting you automatically away. + "Message ERC will use when setting you automatically away. It is used as a `format' string with the argument of the idletime in seconds." :group 'erc-autoaway diff --git a/lisp/erc/erc-backend.el b/lisp/erc/erc-backend.el index 7bc56584eaf..62f524ed001 100644 --- a/lisp/erc/erc-backend.el +++ b/lisp/erc/erc-backend.el @@ -311,7 +311,7 @@ If a key is pressed while ERC is waiting, it will stop waiting." :type 'number) (defcustom erc-split-line-length 440 - "*The maximum length of a single message. + "The maximum length of a single message. If a message exceeds this size, it is broken into multiple ones. IRC allows for lines up to 512 bytes. Two of them are CR LF. @@ -379,14 +379,14 @@ It should take same arguments as `open-network-stream' does." :type 'function) (defcustom erc-server-prevent-duplicates '("301") - "*Either nil or a list of strings. + "Either nil or a list of strings. Each string is a IRC message type, like PRIVMSG or NOTICE. All Message types in that list of subjected to duplicate prevention." :type '(choice (const nil) (list string)) :group 'erc-server) (defcustom erc-server-duplicate-timeout 60 - "*The time allowed in seconds between duplicate messages. + "The time allowed in seconds between duplicate messages. If two identical messages arrive within this value of one another, the second isn't displayed." @@ -399,7 +399,7 @@ isn't displayed." ;; (http://www.nongnu.org/circe) (defcustom erc-server-flood-margin 10 - "*A margin on how much excess data we send. + "A margin on how much excess data we send. The flood protection algorithm of ERC works like the one detailed in RFC 2813, section 5.8 \"Flood control of clients\". @@ -423,14 +423,14 @@ protection algorithm." ;; Ping handling (defcustom erc-server-send-ping-interval 30 - "*Interval of sending pings to the server, in seconds. + "Interval of sending pings to the server, in seconds. If this is set to nil, pinging the server is disabled." :group 'erc-server :type '(choice (const :tag "Disabled" nil) (integer :tag "Seconds"))) (defcustom erc-server-send-ping-timeout 120 - "*If the time between ping and response is greater than this, reconnect. + "If the time between ping and response is greater than this, reconnect. The time is in seconds. This must be greater than or equal to the value for diff --git a/lisp/erc/erc-button.el b/lisp/erc/erc-button.el index 17b8c457f38..727e3de58e8 100644 --- a/lisp/erc/erc-button.el +++ b/lisp/erc/erc-button.el @@ -115,13 +115,13 @@ longer than `erc-fill-column'." :type 'boolean) (defcustom erc-button-rfc-url "http://www.faqs.org/rfcs/rfc%s.html" - "*URL used to browse rfc references. + "URL used to browse rfc references. %s is replaced by the number." :group 'erc-button :type 'string) (defcustom erc-button-google-url "http://www.google.com/search?q=%s" - "*URL used to browse Google search references. + "URL used to browse Google search references. %s is replaced by the search string." :group 'erc-button :type 'string) @@ -155,7 +155,7 @@ longer than `erc-fill-column'." 1) ;; other ("\\s-\\(@\\([0-9][0-9][0-9]\\)\\)" 1 t erc-button-beats-to-time 2)) - "*Alist of regexps matching buttons in ERC buffers. + "Alist of regexps matching buttons in ERC buffers. Each entry has the form (REGEXP BUTTON FORM CALLBACK PAR...), where REGEXP is the string matching text around the button or a symbol @@ -198,12 +198,12 @@ PAR is a number of a regexp grouping whose text will be passed to (integer :tag "Regexp section number"))))) (defcustom erc-emacswiki-url "http://www.emacswiki.org/cgi-bin/wiki.pl?" - "*URL of the EmacsWiki Homepage." + "URL of the EmacsWiki Homepage." :group 'erc-button :type 'string) (defcustom erc-emacswiki-lisp-url "http://www.emacswiki.org/elisp/" - "*URL of the EmacsWiki ELisp area." + "URL of the EmacsWiki ELisp area." :group 'erc-button :type 'string) @@ -488,7 +488,7 @@ For use on `completion-at-point-functions'." ("Query" . (erc-cmd-QUERY nick)) ("Whois" . (erc-cmd-WHOIS nick)) ("Lastlog" . (erc-cmd-LASTLOG nick))) - "*An alist of possible actions to take on a nickname. + "An alist of possible actions to take on a nickname. An entry looks like (\"Action\" . SEXP) where SEXP is evaluated with the variable `nick' bound to the nick in question. diff --git a/lisp/erc/erc-dcc.el b/lisp/erc/erc-dcc.el index f68b3591fbb..ba87cf63993 100644 --- a/lisp/erc/erc-dcc.el +++ b/lisp/erc/erc-dcc.el @@ -75,7 +75,7 @@ IRC users." :group 'erc) (defcustom erc-dcc-verbose nil - "*If non-nil, be verbose about DCC activity reporting." + "If non-nil, be verbose about DCC activity reporting." :group 'erc-dcc :type 'boolean) @@ -316,7 +316,7 @@ Should be set to a string or nil. If nil, use the value of :valid-regexp erc-dcc-ipv4-regexp))) (defcustom erc-dcc-send-request 'ask - "*How to treat incoming DCC Send requests. + "How to treat incoming DCC Send requests. 'ask - Report the Send request, and wait for the user to manually accept it You might want to set `erc-dcc-auto-masks' for this. 'auto - Automatically accept the request and begin downloading the file @@ -405,7 +405,7 @@ the accepted connection." ;;; Interactive command handling (defcustom erc-dcc-get-default-directory nil - "*Default directory for incoming DCC file transfers. + "Default directory for incoming DCC file transfers. If this is nil, then the current value of `default-directory' is used." :group 'erc-dcc :type '(choice (const nil :tag "Default directory") directory)) @@ -719,7 +719,7 @@ match, returns that regexp and nil otherwise." "^DCC CHAT +chat +\\([0-9]+\\) +\\([0-9]+\\)") (defcustom erc-dcc-chat-request 'ask - "*How to treat incoming DCC Chat requests. + "How to treat incoming DCC Chat requests. 'ask - Report the Chat request, and wait for the user to manually accept it 'auto - Automatically accept the request and open a new chat window 'ignore - Ignore incoming DCC chat requests completely." @@ -777,12 +777,12 @@ match, returns that regexp and nil otherwise." ;;; SEND handling (defcustom erc-dcc-block-size 1024 - "*Block size to use for DCC SEND sessions." + "Block size to use for DCC SEND sessions." :group 'erc-dcc :type 'integer) (defcustom erc-dcc-pump-bytes nil - "*If set to an integer, keep sending until that number of bytes are + "If set to an integer, keep sending until that number of bytes are unconfirmed." :group 'erc-dcc :type '(choice (const nil) integer)) @@ -856,7 +856,7 @@ bytes sent." (defcustom erc-dcc-send-connect-hook '(erc-dcc-display-send erc-dcc-send-block) - "*Hook run whenever the remote end of a DCC SEND offer connected to your + "Hook run whenever the remote end of a DCC SEND offer connected to your listening port." :group 'erc-dcc :type 'hook) @@ -1046,12 +1046,12 @@ transfer is complete." ;;; CHAT handling (defcustom erc-dcc-chat-buffer-name-format "DCC-CHAT-%s" - "*Format to use for DCC Chat buffer names." + "Format to use for DCC Chat buffer names." :group 'erc-dcc :type 'string) (defcustom erc-dcc-chat-mode-hook nil - "*Hook calls when `erc-dcc-chat-mode' finished setting up the buffer." + "Hook calls when `erc-dcc-chat-mode' finished setting up the buffer." :group 'erc-dcc :type 'hook) @@ -1100,7 +1100,7 @@ Possible values are: ask, auto, ignore." (defalias 'pcomplete/erc-mode/SREQ 'pcomplete/erc-mode/CREQ) (defvar erc-dcc-chat-filter-hook '(erc-dcc-chat-parse-output) - "*Hook to run after doing parsing (and possible insertion) of DCC messages.") + "Hook to run after doing parsing (and possible insertion) of DCC messages.") (defvar erc-dcc-chat-mode-map (let ((map (make-sparse-keymap))) diff --git a/lisp/erc/erc-goodies.el b/lisp/erc/erc-goodies.el index bf74ed7be87..acff76beb16 100644 --- a/lisp/erc/erc-goodies.el +++ b/lisp/erc/erc-goodies.el @@ -183,7 +183,7 @@ themselves." :group 'erc) (defcustom erc-interpret-controls-p t - "*If non-nil, display IRC colors and other highlighting effects. + "If non-nil, display IRC colors and other highlighting effects. If this is set to the symbol `remove', ERC removes all IRC colors and highlighting effects. When this variable is non-nil, it can cause Emacs to run @@ -196,7 +196,7 @@ emergency (message flood) it can be turned off to save processing time. See (const :tag "Display raw control characters" nil))) (defcustom erc-interpret-mirc-color nil - "*If non-nil, ERC will interpret mIRC color codes." + "If non-nil, ERC will interpret mIRC color codes." :group 'erc-control-characters :type 'boolean) diff --git a/lisp/erc/erc-log.el b/lisp/erc/erc-log.el index 9f50a1d117c..eefe51ae706 100644 --- a/lisp/erc/erc-log.el +++ b/lisp/erc/erc-log.el @@ -101,7 +101,7 @@ :group 'erc) (defcustom erc-generate-log-file-name-function 'erc-generate-log-file-name-long - "*A function to generate a log filename. + "A function to generate a log filename. The function must take five arguments: BUFFER, TARGET, NICK, SERVER and PORT. BUFFER is the buffer to be saved, TARGET is the name of the channel, or the target of the query, @@ -157,12 +157,12 @@ arguments." (const :tag "Disable logging" nil))) (defcustom erc-log-insert-log-on-open nil - "*Insert log file contents into the buffer if a log file exists." + "Insert log file contents into the buffer if a log file exists." :group 'erc-log :type 'boolean) (defcustom erc-save-buffer-on-part t - "*Save the channel buffer content using `erc-save-buffer-in-logs' on PART. + "Save the channel buffer content using `erc-save-buffer-in-logs' on PART. If you set this to nil, you may want to enable both `erc-log-write-after-send' and `erc-log-write-after-insert'." @@ -170,7 +170,7 @@ If you set this to nil, you may want to enable both :type 'boolean) (defcustom erc-save-queries-on-quit t - "*Save all query (also channel) buffers of the server on QUIT. + "Save all query (also channel) buffers of the server on QUIT. If you set this to nil, you may want to enable both `erc-log-write-after-send' and `erc-log-write-after-insert'." @@ -178,7 +178,7 @@ If you set this to nil, you may want to enable both :type 'boolean) (defcustom erc-log-write-after-send nil - "*If non-nil, write to log file after every message you send. + "If non-nil, write to log file after every message you send. If you set this to nil, you may want to enable both `erc-save-buffer-on-part' and `erc-save-queries-on-quit'." @@ -186,7 +186,7 @@ If you set this to nil, you may want to enable both :type 'boolean) (defcustom erc-log-write-after-insert nil - "*If non-nil, write to log file when new text is added to a + "If non-nil, write to log file when new text is added to a logged ERC buffer. If you set this to nil, you may want to enable both @@ -197,14 +197,14 @@ If you set this to nil, you may want to enable both (defcustom erc-log-file-coding-system (if (featurep 'xemacs) 'binary 'emacs-mule) - "*The coding system ERC should use for writing log files. + "The coding system ERC should use for writing log files. This should ideally, be a \"catch-all\" coding system, like `emacs-mule', or `iso-2022-7bit'." :group 'erc-log) (defcustom erc-log-filter-function nil - "*If non-nil, pass text through the given function before writing it to + "If non-nil, pass text through the given function before writing it to a log file. The function should take one argument, which is the text to filter." diff --git a/lisp/erc/erc-match.el b/lisp/erc/erc-match.el index 2a61247307f..dd9e02dfab5 100644 --- a/lisp/erc/erc-match.el +++ b/lisp/erc/erc-match.el @@ -83,7 +83,7 @@ Useful to mark nicks from dangerous hosts." :type '(repeat regexp)) (defcustom erc-current-nick-highlight-type 'keyword - "*Determines how to highlight text in which your current nickname appears + "Determines how to highlight text in which your current nickname appears \(does not apply to text sent by you\). The following values are allowed: @@ -105,7 +105,7 @@ Any other value disables highlighting of current nickname altogether." (const all))) (defcustom erc-pal-highlight-type 'nick - "*Determines how to highlight messages by pals. + "Determines how to highlight messages by pals. See `erc-pals'. The following values are allowed: @@ -121,7 +121,7 @@ Any other value disables pal highlighting altogether." (const all))) (defcustom erc-fool-highlight-type 'nick - "*Determines how to highlight messages by fools. + "Determines how to highlight messages by fools. See `erc-fools'. The following values are allowed: @@ -137,7 +137,7 @@ Any other value disables fool highlighting altogether." (const all))) (defcustom erc-keyword-highlight-type 'keyword - "*Determines how to highlight messages containing keywords. + "Determines how to highlight messages containing keywords. See variable `erc-keywords'. The following values are allowed: @@ -152,7 +152,7 @@ Any other value disables keyword highlighting altogether." (const all))) (defcustom erc-dangerous-host-highlight-type 'nick - "*Determines how to highlight messages by nicks from dangerous-hosts. + "Determines how to highlight messages by nicks from dangerous-hosts. See `erc-dangerous-hosts'. The following values are allowed: diff --git a/lisp/erc/erc-notify.el b/lisp/erc/erc-notify.el index d1a33405765..3bf82c13f19 100644 --- a/lisp/erc/erc-notify.el +++ b/lisp/erc/erc-notify.el @@ -40,19 +40,19 @@ :group 'erc) (defcustom erc-notify-list nil - "*List of nicknames you want to be notified about online/offline + "List of nicknames you want to be notified about online/offline status change." :group 'erc-notify :type '(repeat string)) (defcustom erc-notify-interval 60 - "*Time interval (in seconds) for checking online status of notified + "Time interval (in seconds) for checking online status of notified people." :group 'erc-notify :type 'integer) (defcustom erc-notify-signon-hook nil - "*Hook run after someone on `erc-notify-list' has signed on. + "Hook run after someone on `erc-notify-list' has signed on. Two arguments are passed to the function, SERVER and NICK, both strings." :group 'erc-notify @@ -60,7 +60,7 @@ strings." :options '(erc-notify-signon)) (defcustom erc-notify-signoff-hook nil - "*Hook run after someone on `erc-notify-list' has signed off. + "Hook run after someone on `erc-notify-list' has signed off. Two arguments are passed to the function, SERVER and NICK, both strings." :group 'erc-notify diff --git a/lisp/erc/erc-pcomplete.el b/lisp/erc/erc-pcomplete.el index ba27b0374aa..d3cbe8a5804 100644 --- a/lisp/erc/erc-pcomplete.el +++ b/lisp/erc/erc-pcomplete.el @@ -49,7 +49,7 @@ :group 'erc) (defcustom erc-pcomplete-nick-postfix ":" - "*When `pcomplete' is used in the first word after the prompt, + "When `pcomplete' is used in the first word after the prompt, add this string to nicks completed." :group 'erc-pcomplete :type 'string) diff --git a/lisp/erc/erc-sound.el b/lisp/erc/erc-sound.el index 569abad2a08..8b44cb5146c 100644 --- a/lisp/erc/erc-sound.el +++ b/lisp/erc/erc-sound.el @@ -62,7 +62,7 @@ and play sound files as requested." :group 'erc) (defcustom erc-play-sound t - "*Play sounds when you receive CTCP SOUND requests." + "Play sounds when you receive CTCP SOUND requests." :group 'erc-sound :type 'boolean) diff --git a/lisp/erc/erc-stamp.el b/lisp/erc/erc-stamp.el index e02b045ebd2..4d55e21da72 100644 --- a/lisp/erc/erc-stamp.el +++ b/lisp/erc/erc-stamp.el @@ -47,7 +47,7 @@ in your .emacs file or interactively using `load-library'." :group 'erc) (defcustom erc-timestamp-format "[%H:%M]" - "*If set to a string, messages will be timestamped. + "If set to a string, messages will be timestamped. This string is processed using `format-time-string'. Good examples are \"%T\" and \"%H:%M\". @@ -57,7 +57,7 @@ If nil, timestamping is turned off." (string))) (defcustom erc-timestamp-format-left "\n[%a %b %e %Y]\n" - "*If set to a string, messages will be timestamped. + "If set to a string, messages will be timestamped. This string is processed using `format-time-string'. Good examples are \"%T\" and \"%H:%M\". @@ -71,7 +71,7 @@ If nil, timestamping is turned off." (string))) (defcustom erc-timestamp-format-right " [%H:%M]" - "*If set to a string, messages will be timestamped. + "If set to a string, messages will be timestamped. This string is processed using `format-time-string'. Good examples are \"%T\" and \"%H:%M\". @@ -85,7 +85,7 @@ If nil, timestamping is turned off." (string))) (defcustom erc-insert-timestamp-function 'erc-insert-timestamp-left-and-right - "*Function to use to insert timestamps. + "Function to use to insert timestamps. It takes a single argument STRING which is the final string which all text-properties already appended. This function only cares about @@ -102,7 +102,7 @@ You will probably want to set function)) (defcustom erc-away-timestamp-format "<%H:%M>" - "*Timestamp format used when marked as being away. + "Timestamp format used when marked as being away. If nil, timestamping is turned off when away unless `erc-timestamp-format' is set. @@ -114,7 +114,7 @@ If `erc-timestamp-format' is set, this will not be used." (defcustom erc-insert-away-timestamp-function 'erc-insert-timestamp-left-and-right - "*Function to use to insert the away timestamp. + "Function to use to insert the away timestamp. See `erc-insert-timestamp-function' for details." :group 'erc-stamp @@ -124,7 +124,7 @@ See `erc-insert-timestamp-function' for details." function)) (defcustom erc-hide-timestamps nil - "*If non-nil, timestamps will be invisible. + "If non-nil, timestamps will be invisible. This is useful for logging, because, although timestamps will be hidden, they will still be present in the logs." @@ -132,7 +132,7 @@ hidden, they will still be present in the logs." :type 'boolean) (defcustom erc-echo-timestamps nil - "*If non-nil, print timestamp in the minibuffer when point is moved. + "If non-nil, print timestamp in the minibuffer when point is moved. Using this variable, you can turn off normal timestamping, and simply move point to an irc message to see its timestamp printed in the minibuffer." @@ -140,14 +140,14 @@ printed in the minibuffer." :type 'boolean) (defcustom erc-echo-timestamp-format "Timestamped %A, %H:%M:%S" - "*Format string to be used when `erc-echo-timestamps' is non-nil. + "Format string to be used when `erc-echo-timestamps' is non-nil. This string specifies the format of the timestamp being echoed in the minibuffer." :group 'erc-stamp :type 'string) (defcustom erc-timestamp-intangible t - "*Whether the timestamps should be intangible, i.e. prevent the point + "Whether the timestamps should be intangible, i.e. prevent the point from entering them and instead jump over them." :group 'erc-stamp :type 'boolean) @@ -205,7 +205,7 @@ This is used when `erc-insert-timestamp-function' is set to (make-variable-buffer-local 'erc-timestamp-last-inserted-right) (defcustom erc-timestamp-only-if-changed-flag t - "*Insert timestamp only if its value changed since last insertion. + "Insert timestamp only if its value changed since last insertion. If `erc-insert-timestamp-function' is `erc-insert-timestamp-left', a string of spaces which is the same size as the timestamp is added to the beginning of the line in its place. If you use @@ -215,7 +215,7 @@ timestamp." :type 'boolean) (defcustom erc-timestamp-right-column nil - "*If non-nil, the column at which the timestamp is inserted, + "If non-nil, the column at which the timestamp is inserted, if the timestamp is to be printed to the right. If nil, `erc-insert-timestamp-right' will use other means to determine the correct column." @@ -227,7 +227,7 @@ the correct column." (defcustom erc-timestamp-use-align-to (and (not (featurep 'xemacs)) (>= emacs-major-version 22) (eq window-system 'x)) - "*If non-nil, use the :align-to display property to align the stamp. + "If non-nil, use the :align-to display property to align the stamp. This gives better results when variable-width characters (like Asian language characters and math symbols) precede a timestamp. Unfortunately, it only works in Emacs 22 and when using the X diff --git a/lisp/erc/erc-track.el b/lisp/erc/erc-track.el index ac899302c3c..e4a41089539 100644 --- a/lisp/erc/erc-track.el +++ b/lisp/erc/erc-track.el @@ -93,13 +93,13 @@ Activity means that there was no user input in the last 10 seconds." :type '(repeat string)) (defcustom erc-track-remove-disconnected-buffers nil - "*If true, remove buffers associated with a server that is + "If true, remove buffers associated with a server that is disconnected from `erc-modified-channels-alist'." :group 'erc-track :type 'boolean) (defcustom erc-track-exclude-types '("NICK" "333" "353") - "*List of message types to be ignored. + "List of message types to be ignored. This list could look like '(\"JOIN\" \"PART\"). By default, exclude changes of nicknames (NICK), display of who @@ -109,7 +109,7 @@ channel (353)." :type 'erc-message-type) (defcustom erc-track-exclude-server-buffer nil - "*If true, don't perform tracking on the server buffer; this is + "If true, don't perform tracking on the server buffer; this is useful for excluding all the things like MOTDs from the server and other miscellaneous functions." :group 'erc-track @@ -127,7 +127,7 @@ the mode-line should be reduced to." :type 'number) (defcustom erc-track-shorten-aggressively nil - "*If non-nil, channel names will be shortened more aggressively. + "If non-nil, channel names will be shortened more aggressively. Usually, names are not shortened if this will save only one character. Example: If there are two channels, #linux-de and #linux-fr, then normally these will not be shortened. When shortening aggressively, @@ -150,7 +150,7 @@ This setting is used by `erc-track-shorten-names'." (const :tag "Max" max))) (defcustom erc-track-shorten-function 'erc-track-shorten-names - "*This function will be used to reduce the channel names before display. + "This function will be used to reduce the channel names before display. It takes one argument, CHANNEL-NAMES which is a list of strings. It should return a list of strings of the same number of elements. If nil instead of a function, shortening is disabled." @@ -169,7 +169,7 @@ notification of channel activity." :type 'hook) (defcustom erc-track-use-faces t - "*Use faces in the mode-line. + "Use faces in the mode-line. The faces used are the same as used for text in the buffers. \(e.g. `erc-pal-face' is used if a pal sent a message to that channel.)" :group 'erc-track diff --git a/lisp/erc/erc-truncate.el b/lisp/erc/erc-truncate.el index 6aa4e718d0a..dd47c601ea8 100644 --- a/lisp/erc/erc-truncate.el +++ b/lisp/erc/erc-truncate.el @@ -36,7 +36,7 @@ :group 'erc) (defcustom erc-max-buffer-size 30000 - "*Maximum size in chars of each ERC buffer. + "Maximum size in chars of each ERC buffer. Used only when auto-truncation is enabled. \(see `erc-truncate-buffer' and `erc-insert-post-hook')." :group 'erc-truncate diff --git a/lisp/erc/erc-xdcc.el b/lisp/erc/erc-xdcc.el index 98e26dd9af0..0328c407aa0 100644 --- a/lisp/erc/erc-xdcc.el +++ b/lisp/erc/erc-xdcc.el @@ -29,13 +29,13 @@ (require 'erc-dcc) (defcustom erc-xdcc-files nil - "*List of files to offer via XDCC. + "List of files to offer via XDCC. Your friends should issue \"/ctcp yournick XDCC list\" to see this." :group 'erc-dcc :type '(repeat file)) (defcustom erc-xdcc-verbose-flag t - "*Report XDCC CTCP requests in the server buffer." + "Report XDCC CTCP requests in the server buffer." :group 'erc-dcc :type 'boolean) @@ -43,7 +43,7 @@ Your friends should issue \"/ctcp yournick XDCC list\" to see this." '(("help" . erc-xdcc-help) ("list" . erc-xdcc-list) ("send" . erc-xdcc-send)) - "*Sub-command handler alist for XDCC CTCP queries." + "Sub-command handler alist for XDCC CTCP queries." :group 'erc-dcc :type '(alist :key-type (string :tag "Sub-command") :value-type function)) @@ -54,7 +54,7 @@ Your friends should issue \"/ctcp yournick XDCC list\" to see this." ("Type \"/ctcp " (erc-current-nick) " XDCC list\" to see the list of offered files, then type \"/ctcp " (erc-current-nick) " XDCC send #\" to get a particular file number.")) - "*Help text sent in response to XDCC help command. + "Help text sent in response to XDCC help command. A list of messages, each consisting of strings and expressions, expressions being evaluated and should return strings." :group 'erc-dcc diff --git a/lisp/erc/erc.el b/lisp/erc/erc.el index 63777fb3897..62b701204d1 100644 --- a/lisp/erc/erc.el +++ b/lisp/erc/erc.el @@ -255,7 +255,7 @@ If nil, only \"> \" will be shown." (repeat :inline t :tag "Others" (string :tag "IRC Message Type")))) (defcustom erc-hide-list nil - "*List of IRC type messages to hide. + "List of IRC type messages to hide. A typical value would be '(\"JOIN\" \"PART\" \"QUIT\")." :group 'erc-ignore :type 'erc-message-type) @@ -653,12 +653,12 @@ This only has any meaning if the variable `erc-command-indicator' is non-nil." prompt)))) (defcustom erc-notice-prefix "*** " - "*Prefix for all notices." + "Prefix for all notices." :group 'erc-display :type 'string) (defcustom erc-notice-highlight-type 'all - "*Determines how to highlight notices. + "Determines how to highlight notices. See `erc-notice-prefix'. The following values are allowed: @@ -673,7 +673,7 @@ Any other value disables notice's highlighting altogether." (const :tag "don't highlight notices at all" nil))) (defcustom erc-echo-notice-hook nil - "*Specifies a list of functions to call to echo a private + "Specifies a list of functions to call to echo a private notice. Each function is called with four arguments, the string to display, the parsed server message, the target buffer (or nil), and the sender. The functions are called in order, until a @@ -704,7 +704,7 @@ See also: `erc-echo-notice-always-hook', (defcustom erc-echo-notice-always-hook '(erc-echo-notice-in-default-buffer) - "*Specifies a list of functions to call to echo a private + "Specifies a list of functions to call to echo a private notice. Each function is called with four arguments, the string to display, the parsed server message, the target buffer (or nil), and the sender. The functions are called in order, and all @@ -736,17 +736,17 @@ See also: `erc-echo-notice-hook', ;; other tunable parameters (defcustom erc-whowas-on-nosuchnick nil - "*If non-nil, do a whowas on a nick if no such nick." + "If non-nil, do a whowas on a nick if no such nick." :group 'erc :type 'boolean) (defcustom erc-verbose-server-ping nil - "*If non-nil, show every time you get a PING or PONG from the server." + "If non-nil, show every time you get a PING or PONG from the server." :group 'erc-paranoia :type 'boolean) (defcustom erc-public-away-p nil - "*Let others know you are back when you are no longer marked away. + "Let others know you are back when you are no longer marked away. This happens in this form: * <nick> is back (gone for <time>) @@ -755,7 +755,7 @@ Many consider it impolite to do so automatically." :type 'boolean) (defcustom erc-away-nickname nil - "*The nickname to take when you are marked as being away." + "The nickname to take when you are marked as being away." :group 'erc :type '(choice (const nil) string)) @@ -796,7 +796,7 @@ If nil, ERC will call `system-name' to get this information." string)) (defcustom erc-ignore-list nil - "*List of regexps matching user identifiers to ignore. + "List of regexps matching user identifiers to ignore. A user identifier has the form \"nick!login@host\". If an identifier matches, the message from the person will not be @@ -806,7 +806,7 @@ processed." (make-variable-buffer-local 'erc-ignore-list) (defcustom erc-ignore-reply-list nil - "*List of regexps matching user identifiers to ignore completely. + "List of regexps matching user identifiers to ignore completely. This differs from `erc-ignore-list' in that it also ignores any messages directed at the user. @@ -824,7 +824,7 @@ people. You can update the ERC internal info using /WHO *." :type '(repeat regexp)) (defvar erc-flood-protect t - "*If non-nil, flood protection is enabled. + "If non-nil, flood protection is enabled. Flooding is sending too much information to the server in too short of an interval, which may cause the server to terminate the connection. @@ -854,7 +854,7 @@ directory in the list." :type '(repeat directory)) (defcustom erc-script-echo t - "*If non-nil, echo the IRC script commands locally." + "If non-nil, echo the IRC script commands locally." :group 'erc-scripts :type 'boolean) @@ -929,7 +929,7 @@ will be used as the part message." :type '(repeat (list regexp (choice (string) (function))))) (defcustom erc-quit-reason 'erc-quit-reason-normal - "*A function which returns the reason for quitting. + "A function which returns the reason for quitting. The function is passed a single argument, the string typed by the user after \"/quit\"." @@ -1480,7 +1480,7 @@ The available choices are: (const :tag "Use current buffer" t))) (defcustom erc-frame-alist nil - "*Alist of frame parameters for creating erc frames. + "Alist of frame parameters for creating erc frames. A value of nil means to use `default-frame-alist'." :group 'erc-buffers :type '(repeat (cons :format "%v" @@ -1488,13 +1488,13 @@ A value of nil means to use `default-frame-alist'." (sexp :tag "Value")))) (defcustom erc-frame-dedicated-flag nil - "*Non-nil means the erc frames are dedicated to that buffer. + "Non-nil means the erc frames are dedicated to that buffer. This only has effect when `erc-join-buffer' is set to `frame'." :group 'erc-buffers :type 'boolean) (defcustom erc-reuse-frames t - "*Determines whether new frames are always created. + "Determines whether new frames are always created. Non-nil means that a new frame is not created to display an ERC buffer if there is already a window displaying it. This only has effect when `erc-join-buffer' is set to `frame'." @@ -1511,7 +1511,7 @@ effect when `erc-join-buffer' is set to `frame'." (t nil))) (defcustom erc-reuse-buffers t - "*If nil, create new buffers on joining a channel/query. + "If nil, create new buffers on joining a channel/query. If non-nil, a new buffer will only be created when you join channels with same names on different servers, or have query buffers open with nicks of the same name on different servers. Otherwise, @@ -3799,7 +3799,7 @@ This places `point' just after the prompt, or at the beginning of the line." (defcustom erc-default-server-hook '(erc-debug-missing-hooks erc-default-server-handler) - "*Default for server messages which aren't covered by `erc-server-hooks'." + "Default for server messages which aren't covered by `erc-server-hooks'." :group 'erc-server-hooks :type 'hook) @@ -4017,7 +4017,7 @@ and as second argument the event parsed as a vector." str)) (defcustom erc-format-nick-function 'erc-format-nick - "*Function to format a nickname for message display." + "Function to format a nickname for message display." :group 'erc-display :type 'function) @@ -4575,7 +4575,7 @@ channel." (run-hooks 'erc-channel-members-changed-hook))) (defcustom erc-channel-members-changed-hook nil - "*This hook is called every time the variable `channel-members' changes. + "This hook is called every time the variable `channel-members' changes. The buffer where the change happened is current while this hook is called." :group 'erc-hooks :type 'hook) @@ -6386,17 +6386,17 @@ See also `format-spec'." (add-hook 'kill-buffer-hook 'erc-kill-buffer-function) (defcustom erc-kill-server-hook '(erc-kill-server) - "*Invoked whenever a server-buffer is killed via `kill-buffer'." + "Invoked whenever a server-buffer is killed via `kill-buffer'." :group 'erc-hooks :type 'hook) (defcustom erc-kill-channel-hook '(erc-kill-channel) - "*Invoked whenever a channel-buffer is killed via `kill-buffer'." + "Invoked whenever a channel-buffer is killed via `kill-buffer'." :group 'erc-hooks :type 'hook) (defcustom erc-kill-buffer-hook nil - "*Hook run whenever a non-server or channel buffer is killed. + "Hook run whenever a non-server or channel buffer is killed. See also `kill-buffer'." :group 'erc-hooks diff --git a/lisp/facemenu.el b/lisp/facemenu.el index 743115839b2..e76b61fdacb 100644 --- a/lisp/facemenu.el +++ b/lisp/facemenu.el @@ -132,7 +132,7 @@ just before \"Other\" at the end." ,(purecopy "^font-lock-") ,(purecopy "^gnus-") ,(purecopy "^message-") ,(purecopy "^ediff-") ,(purecopy "^term-") ,(purecopy "^vc-") ,(purecopy "^widget-") ,(purecopy "^custom-") ,(purecopy "^vm-")) - "*List of faces that are of no interest to the user.") + "List of faces that are of no interest to the user.") (make-obsolete-variable 'facemenu-unlisted-faces 'facemenu-listed-faces "22.1,\n and has no effect on the Face menu") diff --git a/lisp/faces.el b/lisp/faces.el index 0256f8d951a..8eacf5bcfe2 100644 --- a/lisp/faces.el +++ b/lisp/faces.el @@ -1212,7 +1212,7 @@ Value is a list (FACE NEW-VALUE) where FACE is the face read (defconst list-faces-sample-text "abcdefghijklmnopqrstuvwxyz ABCDEFGHIJKLMNOPQRSTUVWXYZ" - "*Text string to display as the sample text for `list-faces-display'.") + "Text string to display as the sample text for `list-faces-display'.") ;; The name list-faces would be more consistent, but let's avoid a diff --git a/lisp/ffap.el b/lisp/ffap.el index 99017d27490..52ffc9905ed 100644 --- a/lisp/ffap.el +++ b/lisp/ffap.el @@ -1472,7 +1472,7 @@ and the functions `ffap-file-at-point' and `ffap-url-at-point'." ;;; Menu support (`ffap-menu'): (defvar ffap-menu-regexp nil - "*If non-nil, overrides `ffap-next-regexp' during `ffap-menu'. + "If non-nil, overrides `ffap-next-regexp' during `ffap-menu'. Make this more restrictive for faster menu building. For example, try \":/\" for URL (and some ftp) references.") diff --git a/lisp/find-file.el b/lisp/find-file.el index 19fa8283b06..fe1ab96add9 100644 --- a/lisp/find-file.el +++ b/lisp/find-file.el @@ -190,7 +190,7 @@ To override this, give an argument to `ff-find-other-file'." ) ;; We include `ff-treat-as-special' documentation here so that autoload ;; can make it available to be read prior to loading this file. - "*List of special constructs for `ff-treat-as-special' to recognize. + "List of special constructs for `ff-treat-as-special' to recognize. Each element, tried in order, has the form (REGEXP . EXTRACT). If REGEXP matches the current line (from the beginning of the line), `ff-treat-as-special' calls function EXTRACT with no args. diff --git a/lisp/follow.el b/lisp/follow.el index a29f733148c..850cb7b22db 100644 --- a/lisp/follow.el +++ b/lisp/follow.el @@ -393,7 +393,7 @@ are \" Fw\", or simply \"\"." :group 'follow) (defvar follow-avoid-tail-recenter-p (not (featurep 'xemacs)) - "*When non-nil, patch Emacs so that tail windows won't be recentered. + "When non-nil, patch Emacs so that tail windows won't be recentered. A \"tail window\" is a window that displays only the end of the buffer. Normally it is practical for the user that empty @@ -424,7 +424,7 @@ To mark other commands as suitable for caching, set the symbol property `follow-mode-use-cache' to non-nil.") (defvar follow-debug nil - "*Non-nil when debugging Follow mode.") + "Non-nil when debugging Follow mode.") ;; Internal variables: diff --git a/lisp/font-lock.el b/lisp/font-lock.el index b65828ca1d7..910585f21f1 100644 --- a/lisp/font-lock.el +++ b/lisp/font-lock.el @@ -492,11 +492,11 @@ This is normally set via `font-lock-add-keywords' and `font-lock-remove-keywords'.") (defvar font-lock-keywords-only nil - "*Non-nil means Font Lock should not fontify comments or strings. + "Non-nil means Font Lock should not fontify comments or strings. This is normally set via `font-lock-defaults'.") (defvar font-lock-keywords-case-fold-search nil - "*Non-nil means the patterns in `font-lock-keywords' are case-insensitive. + "Non-nil means the patterns in `font-lock-keywords' are case-insensitive. This is set via the function `font-lock-set-defaults', based on the CASE-FOLD argument of `font-lock-defaults'.") (make-variable-buffer-local 'font-lock-keywords-case-fold-search) @@ -556,7 +556,7 @@ If this is nil, the major mode's syntax table is used. This is normally set via `font-lock-defaults'.") (defvar font-lock-beginning-of-syntax-function nil - "*Non-nil means use this function to move back outside all constructs. + "Non-nil means use this function to move back outside all constructs. When called with no args it should move point backward to a place which is not in a string or comment and not within any bracket-pairs (or else, a place such that any bracket-pairs outside it can be ignored for Emacs @@ -571,7 +571,7 @@ This is normally set via `font-lock-defaults'.") 'syntax-begin-function "23.3" 'set) (defvar font-lock-mark-block-function nil - "*Non-nil means use this function to mark a block of text. + "Non-nil means use this function to mark a block of text. When called with no args it should leave point at the beginning of any enclosing textual block and mark at the end. This is normally set via `font-lock-defaults'.") diff --git a/lisp/forms.el b/lisp/forms.el index 007d85caacf..38670e42bdd 100644 --- a/lisp/forms.el +++ b/lisp/forms.el @@ -2031,7 +2031,7 @@ Usage: (setq forms-number-of-fields ;;; Debugging (defvar forms--debug nil - "*Enables forms-mode debugging if not nil.") + "Enables forms-mode debugging if not nil.") (defun forms--debug (&rest args) "Internal debugging routine." diff --git a/lisp/ido.el b/lisp/ido.el index fe94c7f225e..bbf3fe2a1d0 100644 --- a/lisp/ido.el +++ b/lisp/ido.el @@ -872,7 +872,7 @@ The following variables are available, but should not be changed: :group 'ido) (defvar ido-rewrite-file-prompt-rules nil - "*Alist of rewriting rules for directory names in ido prompts. + "Alist of rewriting rules for directory names in ido prompts. A list of elements of the form (FROM . TO) or (FROM . FUNC), each meaning to rewrite the directory name if matched by FROM by either substituting the matched string by TO or calling the function FUNC @@ -894,7 +894,7 @@ Otherwise, only the current list of matches is shown." :group 'ido) (defvar ido-all-frames 'visible - "*Argument to pass to `walk-windows' when finding visible files. + "Argument to pass to `walk-windows' when finding visible files. See documentation of `walk-windows' for useful values.") (defcustom ido-minibuffer-setup-hook nil diff --git a/lisp/iswitchb.el b/lisp/iswitchb.el index 86cef14960e..9600bd1db2d 100644 --- a/lisp/iswitchb.el +++ b/lisp/iswitchb.el @@ -373,7 +373,7 @@ See also `iswitchb-newbuffer'." :group 'iswitchb) (defvar iswitchb-all-frames 'visible - "*Argument to pass to `walk-windows' when finding visible buffers. + "Argument to pass to `walk-windows' when finding visible buffers. See documentation of `walk-windows' for useful values.") (defcustom iswitchb-minibuffer-setup-hook nil diff --git a/lisp/kmacro.el b/lisp/kmacro.el index c8dd05f7c4d..b715e44387e 100644 --- a/lisp/kmacro.el +++ b/lisp/kmacro.el @@ -231,12 +231,12 @@ macro to be executed before appending to it." ;;; Keyboard macro counter (defvar kmacro-counter 0 - "*Current keyboard macro counter.") + "Current keyboard macro counter.") (defvar kmacro-default-counter-format "%d") (defvar kmacro-counter-format "%d" - "*Current keyboard macro counter format.") + "Current keyboard macro counter format.") (defvar kmacro-counter-format-start kmacro-counter-format "Macro format at start of macro execution.") diff --git a/lisp/language/ethio-util.el b/lisp/language/ethio-util.el index e61645c10fc..90e649c574c 100644 --- a/lisp/language/ethio-util.el +++ b/lisp/language/ethio-util.el @@ -99,34 +99,34 @@ ;; (defvar ethio-primary-language 'tigrigna - "*Symbol that defines the primary language in SERA --> FIDEL conversion. + "Symbol that defines the primary language in SERA --> FIDEL conversion. The value should be one of: `tigrigna', `amharic' or `english'.") (defvar ethio-secondary-language 'english - "*Symbol that defines the secondary language in SERA --> FIDEL conversion. + "Symbol that defines the secondary language in SERA --> FIDEL conversion. The value should be one of: `tigrigna', `amharic' or `english'.") (defvar ethio-use-colon-for-colon nil - "*Non-nil means associate ASCII colon with Ethiopic colon. + "Non-nil means associate ASCII colon with Ethiopic colon. If nil, associate ASCII colon with Ethiopic word separator, i.e., two vertically stacked dots. All SERA <--> FIDEL converters refer this variable.") (defvar ethio-use-three-dot-question nil - "*Non-nil means associate ASCII question mark with Ethiopic old style question mark (three vertically stacked dots). + "Non-nil means associate ASCII question mark with Ethiopic old style question mark (three vertically stacked dots). If nil, associate ASCII question mark with Ethiopic stylized question mark. All SERA <--> FIDEL converters refer this variable.") (defvar ethio-quote-vowel-always nil - "*Non-nil means always put an apostrophe before an isolated vowel (except at word initial) in FIDEL --> SERA conversion. + "Non-nil means always put an apostrophe before an isolated vowel (except at word initial) in FIDEL --> SERA conversion. If nil, put an apostrophe only between a 6th-form consonant and an isolated vowel.") (defvar ethio-W-sixth-always nil - "*Non-nil means convert the Wu-form of a 12-form consonant to \"W'\" instead of \"Wu\" in FIDEL --> SERA conversion.") + "Non-nil means convert the Wu-form of a 12-form consonant to \"W'\" instead of \"Wu\" in FIDEL --> SERA conversion.") (defvar ethio-numeric-reduction 0 - "*Degree of reduction in converting Ethiopic digits into Arabic digits. + "Degree of reduction in converting Ethiopic digits into Arabic digits. Should be 0, 1 or 2. For example, ({10}{9}{100}{80}{7}) is converted into: `10`9`100`80`7 if `ethio-numeric-reduction' is 0, @@ -134,7 +134,7 @@ For example, ({10}{9}{100}{80}{7}) is converted into: `10900807 if `ethio-numeric-reduction' is 2.") (defvar ethio-java-save-lowercase nil - "*Non-nil means save Ethiopic characters in lowercase hex numbers to Java files. + "Non-nil means save Ethiopic characters in lowercase hex numbers to Java files. If nil, use uppercases.") (defun ethio-prefer-amharic-p () diff --git a/lisp/language/korea-util.el b/lisp/language/korea-util.el index f8dfdf45d00..ee8ebb7b2e7 100644 --- a/lisp/language/korea-util.el +++ b/lisp/language/korea-util.el @@ -32,7 +32,7 @@ (purecopy (if (string-match "3" (or (getenv "HANGUL_KEYBOARD_TYPE") "")) "3" "")) - "*The kind of Korean keyboard for Korean input method. + "The kind of Korean keyboard for Korean input method. \"\" for 2, \"3\" for 3.") ;; functions useful for Korean text input diff --git a/lisp/language/tibet-util.el b/lisp/language/tibet-util.el index 66795201f7f..f6dd15bf222 100644 --- a/lisp/language/tibet-util.el +++ b/lisp/language/tibet-util.el @@ -398,7 +398,7 @@ See also docstring of the function tibetan-compose-region." )))) (defvar tibetan-strict-unicode t - "*Flag to control Tibetan canonicalizing for Unicode. + "Flag to control Tibetan canonicalizing for Unicode. If non-nil, the vowel a is removed and composite vowels are decomposed before writing buffer in Unicode. See also diff --git a/lisp/mail/binhex.el b/lisp/mail/binhex.el index dd76ce90809..40ea8fa4a82 100644 --- a/lisp/mail/binhex.el +++ b/lisp/mail/binhex.el @@ -43,20 +43,20 @@ :group 'news) (defcustom binhex-decoder-program "hexbin" - "*Non-nil value should be a string that names a binhex decoder. + "Non-nil value should be a string that names a binhex decoder. The program should expect to read binhex data on its standard input and write the converted data to its standard output." :type 'string :group 'binhex) (defcustom binhex-decoder-switches '("-d") - "*List of command line flags passed to the command `binhex-decoder-program'." + "List of command line flags passed to the command `binhex-decoder-program'." :group 'binhex :type '(repeat string)) (defcustom binhex-use-external (executable-find binhex-decoder-program) - "*Use external binhex program." + "Use external binhex program." :version "22.1" :group 'binhex :type 'boolean) diff --git a/lisp/mail/feedmail.el b/lisp/mail/feedmail.el index 039f3dca4a2..4e76e5cdb64 100644 --- a/lisp/mail/feedmail.el +++ b/lisp/mail/feedmail.el @@ -1340,7 +1340,7 @@ Example 'defadvice' for mail-send: (defvar feedmail-queue-runner-is-active nil - "*Non-nil means we're inside the logic of the queue-running loop. + "Non-nil means we're inside the logic of the queue-running loop. That is, iterating over all messages in the queue to send them. In that case, the value is the name of the queued message file currently being processed. This can be used for differentiating customized code @@ -1371,11 +1371,11 @@ call to `feedmail-run-the-queue'." (defvar feedmail-mail-send-hook nil - "*See documentation for `feedmail-mail-send-hook-splitter'.") + "See documentation for `feedmail-mail-send-hook-splitter'.") (defvar feedmail-mail-send-hook-queued nil - "*See documentation for `feedmail-mail-send-hook-splitter'.") + "See documentation for `feedmail-mail-send-hook-splitter'.") (defun feedmail-confirm-addresses-hook-example () @@ -1514,7 +1514,7 @@ function, for example, to archive all of your sent messages someplace (defvar feedmail-is-a-resend nil - "*Non-nil means the message is a Resend (in the RFC-822 sense). + "Non-nil means the message is a Resend (in the RFC-822 sense). This affects the composition of certain headers. feedmail sets this variable as soon as it starts prepping the message text buffer, so any user-supplied functions can rely on it. Users shouldn't set or change this diff --git a/lisp/mail/footnote.el b/lisp/mail/footnote.el index 05949d0eccf..c0a63ef197c 100644 --- a/lisp/mail/footnote.el +++ b/lisp/mail/footnote.el @@ -129,7 +129,7 @@ has no effect on buffers already displaying footnotes." (defvar footnote-signature-separator (if (boundp 'message-signature-separator) message-signature-separator "^-- $") - "*String used to recognize .signatures.") + "String used to recognize .signatures.") ;;; Private variables diff --git a/lisp/mail/hashcash.el b/lisp/mail/hashcash.el index 279b5f7b460..fd8d2633818 100644 --- a/lisp/mail/hashcash.el +++ b/lisp/mail/hashcash.el @@ -58,14 +58,14 @@ :group 'mail) (defcustom hashcash-default-payment 20 - "*The default number of bits to pay to unknown users. + "The default number of bits to pay to unknown users. If this is zero, no payment header will be generated. See `hashcash-payment-alist'." :type 'integer :group 'hashcash) (defcustom hashcash-payment-alist '() - "*An association list mapping email addresses to payment amounts. + "An association list mapping email addresses to payment amounts. Elements may consist of (ADDR AMOUNT) or (ADDR STRING AMOUNT), where ADDR is the email address of the intended recipient and AMOUNT is the value of hashcash payment to be made to that user. STRING, if @@ -80,33 +80,33 @@ present, is the string to be hashed; if not present ADDR will be used." :group 'hashcash) (defcustom hashcash-default-accept-payment 20 - "*The default minimum number of bits to accept on incoming payments." + "The default minimum number of bits to accept on incoming payments." :type 'integer :group 'hashcash) (defcustom hashcash-accept-resources `((,user-mail-address nil)) - "*An association list mapping hashcash resources to payment amounts. + "An association list mapping hashcash resources to payment amounts. Resources named here are to be accepted in incoming payments. If the corresponding AMOUNT is NIL, the value of `hashcash-default-accept-payment' is used instead." :group 'hashcash) (defcustom hashcash-path (executable-find "hashcash") - "*The path to the hashcash binary." + "The path to the hashcash binary." :group 'hashcash) (defcustom hashcash-extra-generate-parameters nil - "*A list of parameter strings passed to `hashcash-path' when minting. + "A list of parameter strings passed to `hashcash-path' when minting. For example, you may want to set this to '(\"-Z2\") to reduce header length." :type '(repeat string) :group 'hashcash) (defcustom hashcash-double-spend-database "hashcash.db" - "*The path to the double-spending database." + "The path to the double-spending database." :group 'hashcash) (defcustom hashcash-in-news nil - "*Specifies whether or not hashcash payments should be made to newsgroups." + "Specifies whether or not hashcash payments should be made to newsgroups." :type 'boolean :group 'hashcash) diff --git a/lisp/mail/mail-extr.el b/lisp/mail/mail-extr.el index 6af9c2478fc..32f99ac1465 100644 --- a/lisp/mail/mail-extr.el +++ b/lisp/mail/mail-extr.el @@ -218,14 +218,14 @@ ;; (defcustom mail-extr-guess-middle-initial nil - "*Whether to try to guess middle initial from mail address. + "Whether to try to guess middle initial from mail address. If true, then when we see an address like \"John Smith <jqs@host.com>\" we will assume that \"John Q. Smith\" is the fellow's name." :type 'boolean :group 'mail-extr) (defcustom mail-extr-ignore-single-names nil - "*Whether to ignore a name that is just a single word. + "Whether to ignore a name that is just a single word. If true, then when we see an address like \"Idiot <dumb@stupid.com>\" we will act as though we couldn't find a full name in the address." :type 'boolean @@ -244,19 +244,19 @@ we will act as though we couldn't find a full name in the address." (defcustom mail-extr-full-name-prefixes (purecopy "\\(Prof\\|D[Rr]\\|Mrs?\\|Rev\\|Rabbi\\|SysOp\\|LCDR\\)\\.?[ \t\n]") - "*Matches prefixes to the full name that identify a person's position. + "Matches prefixes to the full name that identify a person's position. These are stripped from the full name because they do not contribute to uniquely identifying the person." :type 'regexp :group 'mail-extr) (defcustom mail-extr-@-binds-tighter-than-! nil - "*Whether the local mail transport agent looks at ! before @." + "Whether the local mail transport agent looks at ! before @." :type 'boolean :group 'mail-extr) (defcustom mail-extr-mangle-uucp nil - "*Whether to throw away information in UUCP addresses + "Whether to throw away information in UUCP addresses by translating things like \"foo!bar!baz@host\" into \"baz@bar.UUCP\"." :type 'boolean :group 'mail-extr) @@ -1454,7 +1454,7 @@ consing a string.)" )) (defcustom mail-extr-disable-voodoo "\\cj" - "*If it is a regexp, names matching it will never be modified. + "If it is a regexp, names matching it will never be modified. If it is neither nil nor a string, modifying of names will never take place. It affects how `mail-extract-address-components' works." :type '(choice (regexp :size 0) diff --git a/lisp/mail/mail-hist.el b/lisp/mail/mail-hist.el index 0e79992aebe..dd489e3c6a9 100644 --- a/lisp/mail/mail-hist.el +++ b/lisp/mail/mail-hist.el @@ -78,14 +78,14 @@ Used for knowing which history list to look in when the user asks for previous/next input.") (defcustom mail-hist-history-size (or kill-ring-max 1729) - "*The maximum number of elements in a mail field's history. + "The maximum number of elements in a mail field's history. Oldest elements are dumped first." :type 'integer :group 'mail-hist) ;;;###autoload (defcustom mail-hist-keep-history t - "*Non-nil means keep a history for headers and text of outgoing mail." + "Non-nil means keep a history for headers and text of outgoing mail." :type 'boolean :group 'mail-hist) @@ -182,7 +182,7 @@ HEADER is a string without the colon." (cdr (assoc header mail-hist-header-ring-alist))) (defcustom mail-hist-text-size-limit nil - "*Don't store any header or body with more than this many characters. + "Don't store any header or body with more than this many characters. If the value is nil, that means no limit on text size." :type '(choice (const nil) integer) :group 'mail-hist) diff --git a/lisp/mail/mailabbrev.el b/lisp/mail/mailabbrev.el index 51a4c6506be..fb8e1502f91 100644 --- a/lisp/mail/mailabbrev.el +++ b/lisp/mail/mailabbrev.el @@ -255,7 +255,7 @@ By default this is the file specified by `mail-personal-alias-file'." (message "Parsing %s... done" file)) (defvar mail-alias-separator-string ", " - "*A string inserted between addresses in multi-address mail aliases. + "A string inserted between addresses in multi-address mail aliases. This has to contain a comma, so \", \" is a reasonable value. You might also want something like \",\\n \" to get each address on its own line.") @@ -423,7 +423,7 @@ fill-column, break the line at the previous comma, and indent the next line." (defvar mail-abbrev-mode-regexp "^\\(Resent-\\)?\\(To\\|From\\|CC\\|BCC\\|Reply-to\\):" - "*Regexp to select mail-headers in which mail abbrevs should be expanded. + "Regexp to select mail-headers in which mail abbrevs should be expanded. This string will be handed to `looking-at' with point at the beginning of the current line; if it matches, abbrev mode will be turned on, otherwise it will be turned off. (You don't need to worry about continuation lines.) diff --git a/lisp/mail/metamail.el b/lisp/mail/metamail.el index ed2c4a66b7a..60dcd5210e1 100644 --- a/lisp/mail/metamail.el +++ b/lisp/mail/metamail.el @@ -42,23 +42,23 @@ :group 'processes) (defcustom metamail-program-name "metamail" - "*Metamail program name." + "Metamail program name." :type 'string :group 'metamail) (defcustom metamail-mailer-name "emacs" - "*Mailer name set to MM_MAILER environment variable." + "Mailer name set to MM_MAILER environment variable." :type 'string :group 'metamail) (defvar metamail-environment '("KEYHEADS=*" "MM_QUIET=1") - "*Environment variables passed to `metamail'. + "Environment variables passed to `metamail'. It must be a list of strings that have the format ENVVARNAME=VALUE. It is not expected to be altered globally by `set' or `setq'. Instead, change its value temporary using `let' or `let*' form.") (defcustom metamail-switches '("-x" "-d" "-z") - "*Switches for `metamail' program. + "Switches for `metamail' program. `-z' is required to remove zap file. It is not expected to be altered globally by `set' or `setq'. Instead, change its value temporary using `let' or `let*' form. diff --git a/lisp/mail/mspools.el b/lisp/mail/mspools.el index d52d9633ee7..9f9c9c68285 100644 --- a/lisp/mail/mspools.el +++ b/lisp/mail/mspools.el @@ -125,17 +125,17 @@ ) (defcustom mspools-update nil - "*Non-nil means update *spools* buffer after visiting any folder." + "Non-nil means update *spools* buffer after visiting any folder." :type 'boolean :group 'mspools) (defcustom mspools-suffix "spool" - "*Extension used for spool files (not including full stop)." + "Extension used for spool files (not including full stop)." :type 'string :group 'mspools) (defcustom mspools-using-vm (fboundp 'vm) - "*Non-nil if VM is used as mail reader, otherwise RMAIL is used." + "Non-nil if VM is used as mail reader, otherwise RMAIL is used." :type 'boolean :group 'mspools) @@ -143,7 +143,7 @@ (if (boundp 'vm-folder-directory) vm-folder-directory "~/MAIL/") - "*Directory where mail folders are kept. Ensure it has a trailing /. + "Directory where mail folders are kept. Ensure it has a trailing /. Defaults to `vm-folder-directory' if bound else to ~/MAIL/." :type 'directory :group 'mspools) @@ -151,7 +151,7 @@ Defaults to `vm-folder-directory' if bound else to ~/MAIL/." (defcustom mspools-vm-system-mail (or (getenv "MAIL") (concat rmail-spool-directory (user-login-name))) - "*Spool file for main mailbox. Only used by VM. + "Spool file for main mailbox. Only used by VM. This needs to be set to your primary mail spool - mspools will not run without it. By default this will be set to the environment variable $MAIL. Otherwise it will use `rmail-spool-directory' to guess where diff --git a/lisp/mail/rmail.el b/lisp/mail/rmail.el index 3a9ba8122ab..093050229c4 100644 --- a/lisp/mail/rmail.el +++ b/lisp/mail/rmail.el @@ -712,7 +712,7 @@ to an appropriate value, and optionally also set ;; FIXME this is unused since 23.1. (defvar rmail-decode-mime-charset t - "*Non-nil means a message is decoded by MIME's charset specification. + "Non-nil means a message is decoded by MIME's charset specification. If this variable is nil, or the message has not MIME specification, the message is decoded as normal way. @@ -4211,7 +4211,7 @@ This has an effect only if a summary buffer exists." (eval-when-compile (require 'speedbar)) (defvar rmail-speedbar-match-folder-regexp "^[A-Z0-9]+\\(\\.[A-Z0-9]+\\)?$" - "*This regex is used to match folder names to be displayed in speedbar. + "This regex is used to match folder names to be displayed in speedbar. Enabling this will permit speedbar to display your folders for easy browsing, and moving of messages.") @@ -4704,7 +4704,7 @@ SENDERS is a string of regexps separated by commas. ;;;*** ;;;### (autoloads (unforward-rmail-message undigestify-rmail-message) -;;;;;; "undigest" "undigest.el" "a31a35802a2adbc51be42959c3043dbd") +;;;;;; "undigest" "undigest.el" "9f270a2571bbbbfabc27498a8d4089c7") ;;; Generated autoloads from undigest.el (autoload 'undigestify-rmail-message "undigest" "\ diff --git a/lisp/mail/sendmail.el b/lisp/mail/sendmail.el index 933eaef8119..f8958a691b2 100644 --- a/lisp/mail/sendmail.el +++ b/lisp/mail/sendmail.el @@ -989,7 +989,7 @@ This function uses `mail-envelope-from'." ;;;###autoload (defvar sendmail-coding-system nil - "*Coding system for encoding the outgoing mail. + "Coding system for encoding the outgoing mail. This has higher priority than the default `buffer-file-coding-system' and `default-sendmail-coding-system', but lower priority than the local value of `buffer-file-coding-system'. diff --git a/lisp/mail/undigest.el b/lisp/mail/undigest.el index e34a3a4d71e..916a977c546 100644 --- a/lisp/mail/undigest.el +++ b/lisp/mail/undigest.el @@ -32,7 +32,7 @@ (defcustom rmail-forward-separator-regex "^----.*\\([Ff]orwarded\\|[Oo]riginal\\).*[Mm]essage" - "*Regexp to match the string that introduces forwarded messages. + "Regexp to match the string that introduces forwarded messages. This is not a header, but a string contained in the body of the message. You may need to customize it for local needs." :type 'regexp diff --git a/lisp/mail/uudecode.el b/lisp/mail/uudecode.el index d4bf89ffaa1..f415c143473 100644 --- a/lisp/mail/uudecode.el +++ b/lisp/mail/uudecode.el @@ -38,20 +38,20 @@ :group 'news) (defcustom uudecode-decoder-program "uudecode" - "*Non-nil value should be a string that names a uu decoder. + "Non-nil value should be a string that names a uu decoder. The program should expect to read uu data on its standard input and write the converted data to its standard output." :type 'string :group 'uudecode) (defcustom uudecode-decoder-switches nil - "*List of command line flags passed to `uudecode-decoder-program'." + "List of command line flags passed to `uudecode-decoder-program'." :group 'uudecode :type '(repeat string)) (defcustom uudecode-use-external (executable-find uudecode-decoder-program) - "*Use external uudecode program." + "Use external uudecode program." :version "22.1" :group 'uudecode :type 'boolean) diff --git a/lisp/minibuf-eldef.el b/lisp/minibuf-eldef.el index ef1bb115a23..4387fc625c6 100644 --- a/lisp/minibuf-eldef.el +++ b/lisp/minibuf-eldef.el @@ -35,7 +35,7 @@ (defvar minibuffer-default-in-prompt-regexps '(("\\( (default\\>.*)\\):? \\'" . 1) ("\\( \\[.*\\]\\):? *\\'" . 1)) - "*A list of regexps matching the parts of minibuffer prompts showing defaults. + "A list of regexps matching the parts of minibuffer prompts showing defaults. When `minibuffer-electric-default-mode' is active, these regexps are used to identify the portions of prompts to elide. diff --git a/lisp/mouse-drag.el b/lisp/mouse-drag.el index 17591ef12dd..7fb10505355 100644 --- a/lisp/mouse-drag.el +++ b/lisp/mouse-drag.el @@ -169,7 +169,7 @@ Basically, we check for existing horizontal scrolling." nil)))))) (defvar mouse-throw-with-scroll-bar nil - "*Set direction of mouse-throwing. + "Set direction of mouse-throwing. If nil, the text moves in the direction the mouse moves. If t, the scroll bar moves in the direction the mouse moves.") (defconst mouse-throw-magnifier-min -6) diff --git a/lisp/msb.el b/lisp/msb.el index 2c759b1c89d..760ff61a876 100644 --- a/lisp/msb.el +++ b/lisp/msb.el @@ -271,7 +271,7 @@ that differs by this value or more." :group 'msb) (defvar msb-files-by-directory-sort-key 0 - "*The sort key for files sorted by directory.") + "The sort key for files sorted by directory.") (defcustom msb-max-menu-items 15 "The maximum number of items in a menu. @@ -316,7 +316,7 @@ No buffers at all if less than 1 or nil (or any non-number)." :group 'msb) (defvar msb-horizontal-shift-function (lambda () 0) - "*Function that specifies how many pixels to shift the top menu leftwards.") + "Function that specifies how many pixels to shift the top menu leftwards.") (defcustom msb-display-invisible-buffers-p nil "Show invisible buffers or not. @@ -327,7 +327,7 @@ names that starts with a space character." :group 'msb) (defvar msb-item-handling-function 'msb-item-handler - "*The appearance of a buffer menu. + "The appearance of a buffer menu. The default function to call for handling the appearance of a menu item. It should take two arguments, BUFFER and MAX-BUFFER-NAME-LENGTH, diff --git a/lisp/net/ange-ftp.el b/lisp/net/ange-ftp.el index 2a44148e4ce..455836fdae1 100644 --- a/lisp/net/ange-ftp.el +++ b/lisp/net/ange-ftp.el @@ -697,11 +697,11 @@ parenthesized expressions in REGEXP for the components (in that order)." (defvar ange-ftp-multi-msgs "^150-\\|^220-\\|^230-\\|^226\\|^25.-\\|^221-\\|^200-\\|^331-\\|^4[25]1-\\|^530-" - "*Regular expression matching the start of a multiline FTP reply.") + "Regular expression matching the start of a multiline FTP reply.") (defvar ange-ftp-good-msgs "^220 \\|^230 \\|^226 \\|^25. \\|^221 \\|^200 \\|^[Hh]ash mark" - "*Regular expression matching FTP \"success\" messages.") + "Regular expression matching FTP \"success\" messages.") ;; CMS and the odd VMS machine say 200 Port rather than 200 PORT. ;; Also CMS machines use a multiline 550- reply to say that you @@ -908,7 +908,7 @@ matches the login banner." (if (eq system-type 'hpux) "stty -onlcr -echo\n" "stty -echo nl\n") - "*Set up terminal after logging in to the gateway machine. + "Set up terminal after logging in to the gateway machine. This command should stop the terminal from echoing each command, and arrange to strip out trailing ^M characters.") @@ -2098,7 +2098,7 @@ suffix of the form #PORT to specify a non-default port." ;; ange@hplb.hpl.hp.com says this should not be changed. (defvar ange-ftp-hash-mark-msgs "[hH]ash mark [^0-9]*\\([0-9]+\\)" - "*Regexp matching the FTP client's output upon doing a HASH command.") + "Regexp matching the FTP client's output upon doing a HASH command.") (defun ange-ftp-guess-hash-mark-size (proc) (if ange-ftp-send-hash @@ -6079,7 +6079,7 @@ Other orders of $ and _ seem to all work just fine.") (defcustom ange-ftp-bs2000-additional-pubsets nil - "*List of additional pubsets available to all users." + "List of additional pubsets available to all users." :group 'ange-ftp :type '(repeat string)) diff --git a/lisp/net/goto-addr.el b/lisp/net/goto-addr.el index e5fe45b5bf0..6a9d80f9672 100644 --- a/lisp/net/goto-addr.el +++ b/lisp/net/goto-addr.el @@ -80,18 +80,18 @@ ;; I don't expect users to want fontify'ing without highlighting. (defcustom goto-address-fontify-p t - "*Non-nil means URLs and e-mail addresses in buffer are fontified. + "Non-nil means URLs and e-mail addresses in buffer are fontified. But only if `goto-address-highlight-p' is also non-nil." :type 'boolean :group 'goto-address) (defcustom goto-address-highlight-p t - "*Non-nil means URLs and e-mail addresses in buffer are highlighted." + "Non-nil means URLs and e-mail addresses in buffer are highlighted." :type 'boolean :group 'goto-address) (defcustom goto-address-fontify-maximum-size 30000 - "*Maximum size of file in which to fontify and/or highlight URLs. + "Maximum size of file in which to fontify and/or highlight URLs. A value of t means there is no limit--fontify regardless of the size." :type '(choice (integer :tag "Maximum size") (const :tag "No limit" t)) :group 'goto-address) diff --git a/lisp/net/imap.el b/lisp/net/imap.el index 6a25be73615..853839c2061 100644 --- a/lisp/net/imap.el +++ b/lisp/net/imap.el @@ -211,7 +211,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 @@ -271,7 +271,7 @@ See also `imap-log'." (symbol-name system-type)) 1.0 0.1) - "*How long to wait between checking for the end of output. + "How long to wait between checking for the end of output. Shorter values mean quicker response, but is more CPU intensive." :type 'number :group 'imap) diff --git a/lisp/net/quickurl.el b/lisp/net/quickurl.el index 8d6aedff562..b0bfe5b271c 100644 --- a/lisp/net/quickurl.el +++ b/lisp/net/quickurl.el @@ -96,12 +96,12 @@ :prefix "quickurl-") (defcustom quickurl-url-file (convert-standard-filename "~/.quickurls") - "*File that contains the URL list." + "File that contains the URL list." :type 'file :group 'quickurl) (defcustom quickurl-format-function (lambda (url) (format "<URL:%s>" (quickurl-url-url url))) - "*Function to format the URL before insertion into the current buffer." + "Function to format the URL before insertion into the current buffer." :type 'function :group 'quickurl) @@ -111,32 +111,32 @@ (string< (downcase (quickurl-url-description x)) (downcase (quickurl-url-description y)))))) - "*Function to sort the URL list." + "Function to sort the URL list." :type 'function :group 'quickurl) (defcustom quickurl-grab-lookup-function #'current-word - "*Function to grab the thing to lookup." + "Function to grab the thing to lookup." :type 'function :group 'quickurl) (defcustom quickurl-assoc-function #'assoc-ignore-case - "*Function to use for alist lookup into `quickurl-urls'." + "Function to use for alist lookup into `quickurl-urls'." :type 'function :group 'quickurl) (defcustom quickurl-completion-ignore-case t - "*Should `quickurl-ask' ignore case when doing the input lookup?" + "Should `quickurl-ask' ignore case when doing the input lookup?" :type 'boolean :group 'quickurl) (defcustom quickurl-prefix ";; -*- lisp -*-\n\n" - "*Text to write to `quickurl-url-file' before writing the URL list." + "Text to write to `quickurl-url-file' before writing the URL list." :type 'string :group 'quickurl) (defcustom quickurl-postfix "" - "*Text to write to `quickurl-url-file' after writing the URL list. + "Text to write to `quickurl-url-file' after writing the URL list. See the constant `quickurl-reread-hook-postfix' for some example text that could be used here." @@ -144,7 +144,7 @@ could be used here." :group 'quickurl) (defcustom quickurl-list-mode-hook nil - "*Hooks for `quickurl-list-mode'." + "Hooks for `quickurl-list-mode'." :type 'hook :group 'quickurl) diff --git a/lisp/net/rcirc.el b/lisp/net/rcirc.el index d09b6aa831f..9d7e8664542 100644 --- a/lisp/net/rcirc.el +++ b/lisp/net/rcirc.el @@ -139,12 +139,12 @@ for connections using SSL/TLS." :group 'rcirc) (defcustom rcirc-fill-flag t - "*Non-nil means line-wrap messages printed in channel buffers." + "Non-nil means line-wrap messages printed in channel buffers." :type 'boolean :group 'rcirc) (defcustom rcirc-fill-column nil - "*Column beyond which automatic line-wrapping should happen. + "Column beyond which automatic line-wrapping should happen. If nil, use value of `fill-column'. If 'frame-width, use the maximum frame width." :type '(choice (const :tag "Value of `fill-column'") @@ -153,7 +153,7 @@ maximum frame width." :group 'rcirc) (defcustom rcirc-fill-prefix nil - "*Text to insert before filled lines. + "Text to insert before filled lines. If nil, calculate the prefix dynamically to line up text underneath each nick." :type '(choice (const :tag "Dynamic" nil) @@ -174,23 +174,23 @@ Use the command `rcirc-omit-mode' to change this variable.") (make-variable-buffer-local 'rcirc-omit-mode) (defcustom rcirc-time-format "%H:%M " - "*Describes how timestamps are printed. + "Describes how timestamps are printed. Used as the first arg to `format-time-string'." :type 'string :group 'rcirc) (defcustom rcirc-input-ring-size 1024 - "*Size of input history ring." + "Size of input history ring." :type 'integer :group 'rcirc) (defcustom rcirc-read-only-flag t - "*Non-nil means make text in IRC buffers read-only." + "Non-nil means make text in IRC buffers read-only." :type 'boolean :group 'rcirc) (defcustom rcirc-buffer-maximum-lines nil - "*The maximum size in lines for rcirc buffers. + "The maximum size in lines for rcirc buffers. Channel buffers are truncated from the top to be no greater than this number. If zero or nil, no truncating is done." :type '(choice (const :tag "No truncation" nil) @@ -198,7 +198,7 @@ number. If zero or nil, no truncating is done." :group 'rcirc) (defcustom rcirc-scroll-show-maximum-output t - "*If non-nil, scroll buffer to keep the point at the bottom of + "If non-nil, scroll buffer to keep the point at the bottom of the window." :type 'boolean :group 'rcirc) @@ -244,13 +244,13 @@ Examples: :group 'rcirc) (defcustom rcirc-auto-authenticate-flag t - "*Non-nil means automatically send authentication string to server. + "Non-nil means automatically send authentication string to server. See also `rcirc-authinfo'." :type 'boolean :group 'rcirc) (defcustom rcirc-authenticate-before-join t - "*Non-nil means authenticate to services before joining channels. + "Non-nil means authenticate to services before joining channels. Currently only works with NickServ on some networks." :version "24.1" :type 'boolean diff --git a/lisp/net/snmp-mode.el b/lisp/net/snmp-mode.el index 42b6f482665..d3e5759d2fb 100644 --- a/lisp/net/snmp-mode.el +++ b/lisp/net/snmp-mode.el @@ -141,10 +141,10 @@ This is used during Tempo template completion." :group 'snmp) (defvar snmp-tempo-tags nil - "*Tempo tags for SNMP mode.") + "Tempo tags for SNMP mode.") (defvar snmpv2-tempo-tags nil - "*Tempo tags for SNMPv2 mode.") + "Tempo tags for SNMPv2 mode.") ;; Enable fontification for SNMP MIBs diff --git a/lisp/net/socks.el b/lisp/net/socks.el index 3c94e7d1b22..306376f8af2 100644 --- a/lisp/net/socks.el +++ b/lisp/net/socks.el @@ -343,7 +343,7 @@ If PATTERN is omitted, it defaults to \"[ \\f\\t\\n\\r\\v]+\"." ;; could get a wrapper hook, or defer to open-network-stream-function. (defvar socks-override-functions nil - "*Whether to overwrite the open-network-stream function with the SOCKSified + "Whether to overwrite the open-network-stream function with the SOCKSified version.") (require 'network-stream) @@ -480,7 +480,7 @@ version.") ;; Replacement functions for open-network-stream, etc. (defvar socks-noproxy nil - "*List of regexps matching hosts that we should not socksify connections to") + "List of regexps matching hosts that we should not socksify connections to") (defun socks-find-route (host service) (let ((route socks-server) @@ -626,7 +626,7 @@ version.") (defcustom socks-nslookup-program "nslookup" - "*If non-NIL then a string naming the nslookup program." + "If non-NIL then a string naming the nslookup program." :type '(choice (const :tag "None" :value nil) string) :group 'socks) diff --git a/lisp/net/tramp-ftp.el b/lisp/net/tramp-ftp.el index 4b5b08cf7e1..73bc6878115 100644 --- a/lisp/net/tramp-ftp.el +++ b/lisp/net/tramp-ftp.el @@ -99,7 +99,7 @@ present for backward compatibility." ;; Define FTP method ... ;;;###tramp-autoload (defconst tramp-ftp-method "ftp" - "*When this method name is used, forward all calls to Ange-FTP.") + "When this method name is used, forward all calls to Ange-FTP.") ;; ... and add it to the method list. ;;;###tramp-autoload diff --git a/lisp/net/tramp-gvfs.el b/lisp/net/tramp-gvfs.el index 6f3c5e04236..983b29dcb5e 100644 --- a/lisp/net/tramp-gvfs.el +++ b/lisp/net/tramp-gvfs.el @@ -111,7 +111,7 @@ ;;;###tramp-autoload (defcustom tramp-gvfs-methods '("dav" "davs" "obex" "synce") - "*List of methods for remote files, accessed with GVFS." + "List of methods for remote files, accessed with GVFS." :group 'tramp :version "23.2" :type '(repeat (choice (const "dav") @@ -128,7 +128,7 @@ (add-to-list 'tramp-default-user-alist '("\\`synce\\'" nil nil)) (defcustom tramp-gvfs-zeroconf-domain "local" - "*Zeroconf domain to be used for discovering services, like host names." + "Zeroconf domain to be used for discovering services, like host names." :group 'tramp :version "23.2" :type 'string) diff --git a/lisp/net/tramp-gw.el b/lisp/net/tramp-gw.el index de42c402a63..328d094dfa4 100644 --- a/lisp/net/tramp-gw.el +++ b/lisp/net/tramp-gw.el @@ -50,20 +50,20 @@ ;; Define HTTP tunnel method ... ;;;###tramp-autoload (defconst tramp-gw-tunnel-method "tunnel" - "*Method to connect HTTP gateways.") + "Method to connect HTTP gateways.") ;; ... and port. (defconst tramp-gw-default-tunnel-port 8080 - "*Default port for HTTP gateways.") + "Default port for HTTP gateways.") ;; Define SOCKS method ... ;;;###tramp-autoload (defconst tramp-gw-socks-method "socks" - "*Method to connect SOCKS servers.") + "Method to connect SOCKS servers.") ;; ... and port. (defconst tramp-gw-default-socks-port 1080 - "*Default port for SOCKS servers.") + "Default port for SOCKS servers.") ;; Autoload the socks library. It is used only when we access a SOCKS server. (autoload 'socks-open-network-stream "socks") diff --git a/lisp/net/tramp-sh.el b/lisp/net/tramp-sh.el index 1c23a6f20f3..b3a5341b3a6 100644 --- a/lisp/net/tramp-sh.el +++ b/lisp/net/tramp-sh.el @@ -43,7 +43,7 @@ ;; `dired-insert-set-properties'. (defcustom tramp-inline-compress-start-size 4096 - "*The minimum size of compressing where inline transfer. + "The minimum size of compressing where inline transfer. When inline transfer, compress transferred data of file whose size is this value or above (up to `tramp-copy-size-limit'). If it is nil, no compression at all will be applied." @@ -51,14 +51,14 @@ If it is nil, no compression at all will be applied." :type '(choice (const nil) integer)) (defcustom tramp-copy-size-limit 10240 - "*The maximum file size where inline copying is preferred over an out-of-the-band copy. + "The maximum file size where inline copying is preferred over an out-of-the-band copy. If it is nil, inline out-of-the-band copy will be used without a check." :group 'tramp :type '(choice (const nil) integer)) ;;;###tramp-autoload (defcustom tramp-terminal-type "dumb" - "*Value of TERM environment variable for logging in to remote host. + "Value of TERM environment variable for logging in to remote host. Because Tramp wants to parse the output of the remote shell, it is easily confused by ANSI color escape sequences and suchlike. Often, shell init files conditionalize this setup based on the TERM environment variable." @@ -516,7 +516,7 @@ detected as prompt when being sent on echoing hosts, therefore.") '(tramp-default-remote-path "/bin" "/usr/bin" "/usr/sbin" "/usr/local/bin" "/local/bin" "/local/freeware/bin" "/local/gnu/bin" "/usr/freeware/bin" "/usr/pkg/bin" "/usr/contrib/bin") - "*List of directories to search for executables on remote host. + "List of directories to search for executables on remote host. For every remote host, this variable will be set buffer local, keeping the list of existing directories on that host. @@ -546,7 +546,7 @@ as given in your `~/.profile'." "CDPATH=" "HISTORY=" "MAIL=" "MAILCHECK=" "MAILPATH=" "PAGER=\"\"" "autocorrect=" "correct=") - "*List of environment variables to be set on the remote host. + "List of environment variables to be set on the remote host. Each element should be a string of the form ENVVARNAME=VALUE. An entry ENVVARNAME= disables the corresponding environment variable, @@ -558,7 +558,7 @@ not be set here. Instead, it should be set via `tramp-remote-path'." :type '(repeat string)) (defcustom tramp-sh-extra-args '(("/bash\\'" . "-norc -noprofile")) - "*Alist specifying extra arguments to pass to the remote shell. + "Alist specifying extra arguments to pass to the remote shell. Entries are (REGEXP . ARGS) where REGEXP is a regular expression matching the shell file name and ARGS is a string specifying the arguments. diff --git a/lisp/net/tramp-smb.el b/lisp/net/tramp-smb.el index d3f0d8afb12..f1535ae64c0 100644 --- a/lisp/net/tramp-smb.el +++ b/lisp/net/tramp-smb.el @@ -33,7 +33,7 @@ ;; Define SMB method ... ;;;###tramp-autoload (defconst tramp-smb-method "smb" - "*Method to connect SAMBA and M$ SMB servers.") + "Method to connect SAMBA and M$ SMB servers.") ;; ... and add it to the method list. ;;;###tramp-autoload @@ -68,19 +68,19 @@ '((tramp-parse-netrc "~/.netrc")))) (defcustom tramp-smb-program "smbclient" - "*Name of SMB client to run." + "Name of SMB client to run." :group 'tramp :type 'string) (defcustom tramp-smb-conf "/dev/null" - "*Path of the smb.conf file. + "Path of the smb.conf file. If it is nil, no smb.conf will be added to the `tramp-smb-program' call, letting the SMB client use the default one." :group 'tramp :type '(choice (const nil) (file :must-match t))) (defvar tramp-smb-version nil - "*Version string of the SMB client.") + "Version string of the SMB client.") (defconst tramp-smb-prompt "^smb: .+> \\|^\\s-+Server\\s-+Comment$" "Regexp used as prompt in smbclient.") diff --git a/lisp/net/tramp.el b/lisp/net/tramp.el index c092202b10a..5b4ea1e6f17 100644 --- a/lisp/net/tramp.el +++ b/lisp/net/tramp.el @@ -70,13 +70,13 @@ ;; Maybe we need once a real Tramp mode, with key bindings etc. ;;;###autoload (defcustom tramp-mode t - "*Whether Tramp is enabled. + "Whether Tramp is enabled. If it is set to nil, all remote file names are used literally." :group 'tramp :type 'boolean) (defcustom tramp-verbose 3 - "*Verbosity level for Tramp messages. + "Verbosity level for Tramp messages. Any level x includes messages for all levels 1 .. x-1. The levels are 0 silent (no tramp messages at all) @@ -137,7 +137,7 @@ policy for local files." :group 'tramp))) (defcustom tramp-auto-save-directory nil - "*Put auto-save files in this directory, if set. + "Put auto-save files in this directory, if set. The idea is to use a local directory so that auto-saving is faster." :group 'tramp :type '(choice (const nil) string)) @@ -146,7 +146,7 @@ The idea is to use a local directory so that auto-saving is faster." (if (memq system-type '(windows-nt)) (getenv "COMSPEC") "/bin/sh") - "*Use this program for encoding and decoding commands on the local host. + "Use this program for encoding and decoding commands on the local host. This shell is used to execute the encoding and decoding command on the local host, so if you want to use `~' in those commands, you should choose a shell here which groks tilde expansion. `/bin/sh' normally @@ -172,14 +172,14 @@ use for the remote host." (if (string-match "cmd\\.exe" tramp-encoding-shell) "/c" "-c") - "*Use this switch together with `tramp-encoding-shell' for local commands. + "Use this switch together with `tramp-encoding-shell' for local commands. See the variable `tramp-encoding-shell' for more information." :group 'tramp :type 'string) (defcustom tramp-encoding-command-interactive (unless (string-match "cmd\\.exe" tramp-encoding-shell) "-i") - "*Use this switch together with `tramp-encoding-shell' for interactive shells. + "Use this switch together with `tramp-encoding-shell' for interactive shells. See the variable `tramp-encoding-shell' for more information." :version "24.1" :group 'tramp @@ -187,7 +187,7 @@ See the variable `tramp-encoding-shell' for more information." ;;;###tramp-autoload (defvar tramp-methods nil - "*Alist of methods for remote files. + "Alist of methods for remote files. This is a list of entries of the form (NAME PARAM1 PARAM2 ...). Each NAME stands for a remote access method. Each PARAM is a pair of the form (KEY VALUE). The following KEYs are defined: @@ -334,7 +334,7 @@ shouldn't return t when it isn't." (t "ssh"))) ;; Fallback. (t "ftp")) - "*Default method to use for transferring files. + "Default method to use for transferring files. See `tramp-methods' for possibilities. Also see `tramp-default-method-alist'." :group 'tramp @@ -342,7 +342,7 @@ Also see `tramp-default-method-alist'." ;;;###tramp-autoload (defcustom tramp-default-method-alist nil - "*Default method to use for specific host/user pairs. + "Default method to use for specific host/user pairs. This is an alist of items (HOST USER METHOD). The first matching item specifies the method to use for a file name which does not specify a method. HOST and USER are regular expressions or nil, which is @@ -359,7 +359,7 @@ See `tramp-methods' for a list of possibilities for METHOD." (choice :tag "Method name" string (const nil))))) (defcustom tramp-default-user nil - "*Default user to use for transferring files. + "Default user to use for transferring files. It is nil by default; otherwise settings in configuration files like \"~/.ssh/config\" would be overwritten. Also see `tramp-default-user-alist'. @@ -369,7 +369,7 @@ This variable is regarded as obsolete, and will be removed soon." ;;;###tramp-autoload (defcustom tramp-default-user-alist nil - "*Default user to use for specific method/host pairs. + "Default user to use for specific method/host pairs. This is an alist of items (METHOD HOST USER). The first matching item specifies the user to use for a file name which does not specify a user. METHOD and USER are regular expressions or nil, which is @@ -384,13 +384,13 @@ empty string for the method name." (choice :tag " User name" string (const nil))))) (defcustom tramp-default-host (system-name) - "*Default host to use for transferring files. + "Default host to use for transferring files. Useful for su and sudo methods mostly." :group 'tramp :type 'string) (defcustom tramp-default-proxies-alist nil - "*Route to be followed for specific host/user pairs. + "Route to be followed for specific host/user pairs. This is an alist of items (HOST USER PROXY). The first matching item specifies the proxy to be passed for a file name located on a remote target matching USER@HOST. HOST and USER are regular @@ -415,10 +415,10 @@ interpreted as a regular expression which always matches." (regexp-opt (list "localhost" "localhost6" (system-name) "127\.0\.0\.1" "::1") t) "\\'") - "*Host names which are regarded as local host.") + "Host names which are regarded as local host.") (defvar tramp-completion-function-alist nil - "*Alist of methods for remote files. + "Alist of methods for remote files. This is a list of entries of the form \(NAME PAIR1 PAIR2 ...\). Each NAME stands for a remote access method. Each PAIR is of the form \(FUNCTION FILE\). FUNCTION is responsible to extract user names and host @@ -463,13 +463,13 @@ the remote shell.") (defcustom tramp-local-end-of-line (if (memq system-type '(windows-nt)) "\r\n" "\n") - "*String used for end of line in local processes." + "String used for end of line in local processes." :version "24.1" :group 'tramp :type 'string) (defcustom tramp-rsh-end-of-line "\n" - "*String used for end of line in rsh connections. + "String used for end of line in rsh connections. I don't think this ever needs to be changed, so please tell me about it if you need to change this. Also see the method parameter `tramp-password-end-of-line' and the normal @@ -479,7 +479,7 @@ variable `tramp-default-password-end-of-line'." (defcustom tramp-default-password-end-of-line tramp-rsh-end-of-line - "*String used for end of line after sending a password. + "String used for end of line after sending a password. This variable provides the default value for the method parameter `tramp-password-end-of-line', see `tramp-methods' for more details. @@ -494,7 +494,7 @@ The default value is to use the same value as `tramp-rsh-end-of-line'." (defcustom tramp-login-prompt-regexp ".*ogin\\( .*\\)?: *" - "*Regexp matching login-like prompts. + "Regexp matching login-like prompts. The regexp should match at end of buffer. Sometimes the prompt is reported to look like \"login as:\"." @@ -523,7 +523,7 @@ This regexp must match both `tramp-initial-end-of-output' and (defcustom tramp-password-prompt-regexp "^.*\\([pP]assword\\|[pP]assphrase\\).*:\^@? *" - "*Regexp matching password-like prompts. + "Regexp matching password-like prompts. The regexp should match at end of buffer. The `sudo' program appears to insert a `^@' character into the prompt." @@ -549,7 +549,7 @@ The `sudo' program appears to insert a `^@' character into the prompt." ;; Here comes a list of regexes, separated by \\| "Received signal [0-9]+" "\\).*") - "*Regexp matching a `login failed' message. + "Regexp matching a `login failed' message. The regexp should match at end of buffer." :group 'tramp :type 'regexp) @@ -620,7 +620,7 @@ The answer will be provided by `tramp-action-process-alive', :type 'regexp) (defconst tramp-temp-name-prefix "tramp." - "*Prefix to use for temporary files. + "Prefix to use for temporary files. If this is a relative file name (such as \"tramp.\"), it is considered relative to the directory name returned by the function `tramp-compat-temporary-file-directory' (which see). It may also be an @@ -670,76 +670,76 @@ It can have the following values: ((equal tramp-syntax 'sep) "/[") ((equal tramp-syntax 'url) "/") (t (error "Wrong `tramp-syntax' defined"))) - "*String matching the very beginning of Tramp file names. + "String matching the very beginning of Tramp file names. Used in `tramp-make-tramp-file-name'.") (defconst tramp-prefix-regexp (concat "^" (regexp-quote tramp-prefix-format)) - "*Regexp matching the very beginning of Tramp file names. + "Regexp matching the very beginning of Tramp file names. Should always start with \"^\". Derived from `tramp-prefix-format'.") (defconst tramp-method-regexp "[a-zA-Z_0-9-]+" - "*Regexp matching methods identifiers.") + "Regexp matching methods identifiers.") (defconst tramp-postfix-method-format (cond ((equal tramp-syntax 'ftp) ":") ((equal tramp-syntax 'sep) "/") ((equal tramp-syntax 'url) "://") (t (error "Wrong `tramp-syntax' defined"))) - "*String matching delimiter between method and user or host names. + "String matching delimiter between method and user or host names. Used in `tramp-make-tramp-file-name'.") (defconst tramp-postfix-method-regexp (regexp-quote tramp-postfix-method-format) - "*Regexp matching delimiter between method and user or host names. + "Regexp matching delimiter between method and user or host names. Derived from `tramp-postfix-method-format'.") (defconst tramp-user-regexp "[^:/ \t]+" - "*Regexp matching user names.") + "Regexp matching user names.") ;;;###tramp-autoload (defconst tramp-prefix-domain-format "%" - "*String matching delimiter between user and domain names.") + "String matching delimiter between user and domain names.") ;;;###tramp-autoload (defconst tramp-prefix-domain-regexp (regexp-quote tramp-prefix-domain-format) - "*Regexp matching delimiter between user and domain names. + "Regexp matching delimiter between user and domain names. Derived from `tramp-prefix-domain-format'.") (defconst tramp-domain-regexp "[-a-zA-Z0-9_.]+" - "*Regexp matching domain names.") + "Regexp matching domain names.") (defconst tramp-user-with-domain-regexp (concat "\\(" tramp-user-regexp "\\)" tramp-prefix-domain-regexp "\\(" tramp-domain-regexp "\\)") - "*Regexp matching user names with domain names.") + "Regexp matching user names with domain names.") (defconst tramp-postfix-user-format "@" - "*String matching delimiter between user and host names. + "String matching delimiter between user and host names. Used in `tramp-make-tramp-file-name'.") (defconst tramp-postfix-user-regexp (regexp-quote tramp-postfix-user-format) - "*Regexp matching delimiter between user and host names. + "Regexp matching delimiter between user and host names. Derived from `tramp-postfix-user-format'.") (defconst tramp-host-regexp "[a-zA-Z0-9_.-]+" - "*Regexp matching host names.") + "Regexp matching host names.") (defconst tramp-prefix-ipv6-format (cond ((equal tramp-syntax 'ftp) "[") ((equal tramp-syntax 'sep) "") ((equal tramp-syntax 'url) "[") (t (error "Wrong `tramp-syntax' defined"))) - "*String matching left hand side of IPv6 addresses. + "String matching left hand side of IPv6 addresses. Used in `tramp-make-tramp-file-name'.") (defconst tramp-prefix-ipv6-regexp (regexp-quote tramp-prefix-ipv6-format) - "*Regexp matching left hand side of IPv6 addresses. + "Regexp matching left hand side of IPv6 addresses. Derived from `tramp-prefix-ipv6-format'.") ;; The following regexp is a bit sloppy. But it shall serve our @@ -747,19 +747,19 @@ Derived from `tramp-prefix-ipv6-format'.") ;; "::ffff:192.168.0.1". (defconst tramp-ipv6-regexp "\\(?:\\(?:[a-zA-Z0-9]+\\)?:\\)+[a-zA-Z0-9.]+" - "*Regexp matching IPv6 addresses.") + "Regexp matching IPv6 addresses.") (defconst tramp-postfix-ipv6-format (cond ((equal tramp-syntax 'ftp) "]") ((equal tramp-syntax 'sep) "") ((equal tramp-syntax 'url) "]") (t (error "Wrong `tramp-syntax' defined"))) - "*String matching right hand side of IPv6 addresses. + "String matching right hand side of IPv6 addresses. Used in `tramp-make-tramp-file-name'.") (defconst tramp-postfix-ipv6-regexp (regexp-quote tramp-postfix-ipv6-format) - "*Regexp matching right hand side of IPv6 addresses. + "Regexp matching right hand side of IPv6 addresses. Derived from `tramp-postfix-ipv6-format'.") (defconst tramp-prefix-port-format @@ -767,37 +767,37 @@ Derived from `tramp-postfix-ipv6-format'.") ((equal tramp-syntax 'sep) "#") ((equal tramp-syntax 'url) ":") (t (error "Wrong `tramp-syntax' defined"))) - "*String matching delimiter between host names and port numbers.") + "String matching delimiter between host names and port numbers.") (defconst tramp-prefix-port-regexp (regexp-quote tramp-prefix-port-format) - "*Regexp matching delimiter between host names and port numbers. + "Regexp matching delimiter between host names and port numbers. Derived from `tramp-prefix-port-format'.") (defconst tramp-port-regexp "[0-9]+" - "*Regexp matching port numbers.") + "Regexp matching port numbers.") (defconst tramp-host-with-port-regexp (concat "\\(" tramp-host-regexp "\\)" tramp-prefix-port-regexp "\\(" tramp-port-regexp "\\)") - "*Regexp matching host names with port numbers.") + "Regexp matching host names with port numbers.") (defconst tramp-postfix-host-format (cond ((equal tramp-syntax 'ftp) ":") ((equal tramp-syntax 'sep) "]") ((equal tramp-syntax 'url) "") (t (error "Wrong `tramp-syntax' defined"))) - "*String matching delimiter between host names and localnames. + "String matching delimiter between host names and localnames. Used in `tramp-make-tramp-file-name'.") (defconst tramp-postfix-host-regexp (regexp-quote tramp-postfix-host-format) - "*Regexp matching delimiter between host names and localnames. + "Regexp matching delimiter between host names and localnames. Derived from `tramp-postfix-host-format'.") (defconst tramp-localname-regexp ".*$" - "*Regexp matching localnames.") + "Regexp matching localnames.") ;;; File name format: @@ -816,7 +816,7 @@ Derived from `tramp-postfix-host-format'.") "\\(" tramp-localname-regexp "\\)") 2 4 5 8) - "*List of five elements (REGEXP METHOD USER HOST FILE), detailing \ + "List of five elements (REGEXP METHOD USER HOST FILE), detailing \ the Tramp file name structure. The first element REGEXP is a regular expression matching a Tramp file @@ -860,7 +860,7 @@ See `tramp-file-name-structure' for more explanations.") ((equal tramp-syntax 'sep) tramp-file-name-regexp-separate) ((equal tramp-syntax 'url) tramp-file-name-regexp-url) (t (error "Wrong `tramp-syntax' defined"))) - "*Regular expression matching file names handled by Tramp. + "Regular expression matching file names handled by Tramp. This regexp should match Tramp file names but no other file names. When tramp.el is loaded, this regular expression is prepended to `file-name-handler-alist', and that is searched sequentially. Thus, @@ -904,7 +904,7 @@ See `tramp-file-name-structure' for more explanations.") ((equal tramp-syntax 'sep) tramp-completion-file-name-regexp-separate) ((equal tramp-syntax 'url) tramp-completion-file-name-regexp-url) (t (error "Wrong `tramp-syntax' defined"))) - "*Regular expression matching file names handled by Tramp completion. + "Regular expression matching file names handled by Tramp completion. This regexp should match partial Tramp file names only. Please note that the entry in `file-name-handler-alist' is made when @@ -926,7 +926,7 @@ Also see `tramp-file-name-structure'.") ;; Parentheses in docstring starting at beginning of line are escaped. ;; Fontification is messed up when ;; `open-paren-in-column-0-is-defun-start' set to t. - "*If non-nil, chunksize for sending input to local process. + "If non-nil, chunksize for sending input to local process. It is necessary only on systems which have a buggy `process-send-string' implementation. The necessity, whether this variable must be set, can be checked via the following code: diff --git a/lisp/net/webjump.el b/lisp/net/webjump.el index 4b8fbe1e2cf..232e5ca581a 100644 --- a/lisp/net/webjump.el +++ b/lisp/net/webjump.el @@ -276,7 +276,7 @@ function and the `webjump-sites' variable.") (defvar webjump-sites webjump-sample-sites - "*Hotlist for WebJump. + "Hotlist for WebJump. The hotlist is represented as an association list, with the CAR of each cell being the name of the Web site, and the CDR being the definition for the URL of diff --git a/lisp/newcomment.el b/lisp/newcomment.el index 40bb36daf45..37a76e0309c 100644 --- a/lisp/newcomment.el +++ b/lisp/newcomment.el @@ -106,12 +106,12 @@ Comments might be indented to a different value in order not to go beyond ;;;###autoload (defvar comment-start nil - "*String to insert to start a new comment, or nil if no comment syntax.") + "String to insert to start a new comment, or nil if no comment syntax.") ;;;###autoload(put 'comment-start 'safe-local-variable 'string-or-null-p) ;;;###autoload (defvar comment-start-skip nil - "*Regexp to match the start of a comment plus everything up to its body. + "Regexp to match the start of a comment plus everything up to its body. If there are any \\(...\\) pairs, the comment delimiter text is held to begin at the place matched by the close of the first pair.") ;;;###autoload(put 'comment-start-skip 'safe-local-variable 'string-or-null-p) @@ -123,7 +123,7 @@ at the place matched by the close of the first pair.") ;;;###autoload (defvar comment-end (purecopy "") - "*String to insert to end a new comment. + "String to insert to end a new comment. Should be an empty string if comments are terminated by end-of-line.") ;;;###autoload(put 'comment-end 'safe-local-variable 'string-or-null-p) diff --git a/lisp/nxml/nxml-glyph.el b/lisp/nxml/nxml-glyph.el index ba940cd513e..6e15e5d4ce0 100644 --- a/lisp/nxml/nxml-glyph.el +++ b/lisp/nxml/nxml-glyph.el @@ -333,7 +333,7 @@ This repertoire is supported for the following fonts: "Glyph set corresponding to Windows Glyph List 4.") (defvar nxml-glyph-set-hook nil - "*Hook for determining the set of glyphs in a face. + "Hook for determining the set of glyphs in a face. The hook will receive a single argument FACE. If it can determine the set of glyphs representable by FACE, it must set the variable `nxml-glyph-set' and return non-nil. Otherwise, it must return nil. diff --git a/lisp/nxml/rng-nxml.el b/lisp/nxml/rng-nxml.el index 1047ead1b13..a587c14e01a 100644 --- a/lisp/nxml/rng-nxml.el +++ b/lisp/nxml/rng-nxml.el @@ -54,7 +54,7 @@ :group 'relax-ng) (defvar rng-complete-end-tags-after-< t - "*Non-nil means immediately after < complete on end-tag names. + "Non-nil means immediately after < complete on end-tag names. Complete on start-tag names regardless.") (defvar rng-nxml-easy-menu diff --git a/lisp/obsolete/erc-hecomplete.el b/lisp/obsolete/erc-hecomplete.el index 6cc45c21727..8e939169a60 100644 --- a/lisp/obsolete/erc-hecomplete.el +++ b/lisp/obsolete/erc-hecomplete.el @@ -73,7 +73,7 @@ or you may use an arbitrary lisp expression." :group 'erc-hecomplete) (defcustom erc-nick-completion-ignore-case t - "*Non-nil means don't consider case significant in nick completion. + "Non-nil means don't consider case significant in nick completion. Case will be automatically corrected when non-nil. For instance if you type \"dely TAB\" the word completes and changes to \"delYsid\"." @@ -92,7 +92,7 @@ typing \"f o TAB\" will directly give you foobar. Use this with (erc-get-channel-nickname-list))) (defcustom erc-nick-completion-postfix ": " - "*When `erc-complete' is used in the first word after the prompt, + "When `erc-complete' is used in the first word after the prompt, add this string when a unique expansion was found." :group 'erc-hecomplete :type 'string) diff --git a/lisp/obsolete/fast-lock.el b/lisp/obsolete/fast-lock.el index 9eb1d0569f0..125a5dbf6e0 100644 --- a/lisp/obsolete/fast-lock.el +++ b/lisp/obsolete/fast-lock.el @@ -247,7 +247,7 @@ ;; User Variables: (defcustom fast-lock-minimum-size 25600 - "*Minimum size of a buffer for cached fontification. + "Minimum size of a buffer for cached fontification. Only buffers more than this can have associated Font Lock cache files saved. If nil, means cache files are never created. If a list, each element should be a cons pair of the form (MAJOR-MODE . SIZE), @@ -271,7 +271,7 @@ for buffers in Rmail mode, and size is irrelevant otherwise." (defcustom fast-lock-cache-directories '("~/.emacs-flc") ; - `internal', keep each file's Font Lock cache file in the same file. ; - `external', keep each file's Font Lock cache file in the same directory. - "*Directories in which Font Lock cache files are saved and read. + "Directories in which Font Lock cache files are saved and read. Each item should be either DIR or a cons pair of the form (REGEXP . DIR) where DIR is a directory name (relative or absolute) and REGEXP is a regexp. @@ -297,7 +297,7 @@ to avoid the possibility of using the cache of another user." (put 'fast-lock-cache-directories 'risky-local-variable t) (defcustom fast-lock-save-events '(kill-buffer kill-emacs) - "*Events under which caches will be saved. + "Events under which caches will be saved. Valid events are `save-buffer', `kill-buffer' and `kill-emacs'. If concurrent editing sessions use the same associated cache file for a file's buffer, then you should add `save-buffer' to this list." @@ -307,14 +307,14 @@ buffer, then you should add `save-buffer' to this list." :group 'fast-lock) (defcustom fast-lock-save-others t - "*If non-nil, save Font Lock cache files irrespective of file owner. + "If non-nil, save Font Lock cache files irrespective of file owner. If nil, means only buffer files known to be owned by you can have associated Font Lock cache files saved. Ownership may be unknown for networked files." :type 'boolean :group 'fast-lock) (defcustom fast-lock-verbose font-lock-verbose - "*If non-nil, means show status messages for cache processing. + "If non-nil, means show status messages for cache processing. If a number, only buffers greater than this size have processing messages." :type '(choice (const :tag "never" nil) (other :tag "always" t) diff --git a/lisp/obsolete/iso-acc.el b/lisp/obsolete/iso-acc.el index 5a7e99197b8..7e81c4bfb9d 100644 --- a/lisp/obsolete/iso-acc.el +++ b/lisp/obsolete/iso-acc.el @@ -73,7 +73,7 @@ :group 'i18n) (defcustom iso-accents-insert-offset nonascii-insert-offset - "*Offset added by ISO Accents mode to character codes 0200 and above." + "Offset added by ISO Accents mode to character codes 0200 and above." :type 'integer :group 'iso-acc) @@ -262,7 +262,7 @@ Change it with the `iso-accents-customize' function.") "Association list for ISO accent combinations, for the chosen language.") (defcustom iso-accents-mode nil - "*Non-nil enables ISO Accents mode. + "Non-nil enables ISO Accents mode. Setting this variable makes it local to the current buffer. See the function `iso-accents-mode'." :type 'boolean @@ -270,7 +270,7 @@ See the function `iso-accents-mode'." (make-variable-buffer-local 'iso-accents-mode) (defcustom iso-accents-enable '(?' ?` ?^ ?\" ?~ ?/) - "*List of accent keys that become prefixes in ISO Accents mode. + "List of accent keys that become prefixes in ISO Accents mode. The default is (?' ?` ?^ ?\" ?~ ?/), which contains all the supported accent keys. If you set this variable to a list in which some of those characters are missing, the missing ones do not act as accents. diff --git a/lisp/obsolete/resume.el b/lisp/obsolete/resume.el index 905ea07459a..0d4c815722e 100644 --- a/lisp/obsolete/resume.el +++ b/lisp/obsolete/resume.el @@ -47,7 +47,7 @@ ;;; Code: (defvar resume-emacs-args-file (expand-file-name "~/.emacs_args") - "*This file is where arguments are placed for a suspended Emacs job.") + "This file is where arguments are placed for a suspended Emacs job.") (defvar resume-emacs-args-buffer " *Command Line Args*" "Buffer that is used by `resume-process-args'.") diff --git a/lisp/obsolete/scribe.el b/lisp/obsolete/scribe.el index c46c834338f..7ff944c14df 100644 --- a/lisp/obsolete/scribe.el +++ b/lisp/obsolete/scribe.el @@ -45,17 +45,17 @@ "Abbrev table used while in scribe mode.") (defcustom scribe-fancy-paragraphs nil - "*Non-nil makes Scribe mode use a different style of paragraph separation." + "Non-nil makes Scribe mode use a different style of paragraph separation." :type 'boolean :group 'scribe) (defcustom scribe-electric-quote nil - "*Non-nil makes insert of double quote use `` or '' depending on context." + "Non-nil makes insert of double quote use `` or '' depending on context." :type 'boolean :group 'scribe) (defcustom scribe-electric-parenthesis nil - "*Non-nil makes parenthesis char ( (]}> ) automatically insert its close + "Non-nil makes parenthesis char ( (]}> ) automatically insert its close if typed after an @Command form." :type 'boolean :group 'scribe) diff --git a/lisp/org/org-ctags.el b/lisp/org/org-ctags.el index 48656190a0c..8b5bc6ecdf6 100644 --- a/lisp/org/org-ctags.el +++ b/lisp/org/org-ctags.el @@ -188,7 +188,7 @@ See the ctags documentation for more information.") Created as a local variable in each buffer.") (defcustom org-ctags-new-topic-template - "* <<%t>>\n\n\n\n\n\n" + " <<%t>>\n\n\n\n\n\n" "Text to insert when creating a new org file via opening a hyperlink. The following patterns are replaced in the string: `%t' - replaced with the capitalized title of the hyperlink" diff --git a/lisp/org/org-protocol.el b/lisp/org/org-protocol.el index 775f60990d0..419a1ffcaa4 100644 --- a/lisp/org/org-protocol.el +++ b/lisp/org/org-protocol.el @@ -225,7 +225,7 @@ Consider using the interactive functions `org-protocol-create' and :type 'alist) (defcustom org-protocol-protocol-alist nil - "* Register custom handlers for org-protocol. + " Register custom handlers for org-protocol. Each element of this list must be of the form: diff --git a/lisp/outline.el b/lisp/outline.el index da5519f95eb..40974a2c829 100644 --- a/lisp/outline.el +++ b/lisp/outline.el @@ -284,10 +284,10 @@ in the file it applies to." "Normal hook to be run after outline visibility changes.") (defvar outline-mode-hook nil - "*This hook is run when outline mode starts.") + "This hook is run when outline mode starts.") (defvar outline-blank-line nil - "*Non-nil means to leave unhidden blank line before heading.") + "Non-nil means to leave unhidden blank line before heading.") ;;;###autoload (define-derived-mode outline-mode text-mode "Outline" @@ -380,7 +380,7 @@ See the command `outline-mode' for more information on this mode." (show-all))) (defvar outline-level 'outline-level - "*Function of no args to compute a header's nesting level in an outline. + "Function of no args to compute a header's nesting level in an outline. It can assume point is at the beginning of a header line and that the match data reflects the `outline-regexp'.") ;;;###autoload(put 'outline-level 'risky-local-variable t) diff --git a/lisp/paren.el b/lisp/paren.el index 49d2777fd0b..2d6c42478e1 100644 --- a/lisp/paren.el +++ b/lisp/paren.el @@ -96,7 +96,7 @@ otherwise)." 'show-paren-mismatch "22.1") (defvar show-paren-highlight-openparen t - "*Non-nil turns on openparen highlighting when matching forward.") + "Non-nil turns on openparen highlighting when matching forward.") (defvar show-paren-idle-timer nil) diff --git a/lisp/play/animate.el b/lisp/play/animate.el index a1420e62f02..9919600202f 100644 --- a/lisp/play/animate.el +++ b/lisp/play/animate.el @@ -92,7 +92,7 @@ "*Number of steps `animate-string' will place a char before its last position.") (defvar animation-buffer-name nil - "*String naming the default buffer for animations. + "String naming the default buffer for animations. When nil animations displayed in the buffer named *Animation*.") ;;;###autoload diff --git a/lisp/play/gomoku.el b/lisp/play/gomoku.el index 6b6e81dfaba..6d73e2ccb65 100644 --- a/lisp/play/gomoku.el +++ b/lisp/play/gomoku.el @@ -89,16 +89,16 @@ One useful value to include is `turn-on-font-lock' to highlight the pieces." ;; look rectangular, but spacings SHOULD be at least 2 (MUST BE at least 1). (defconst gomoku-square-width 4 - "*Horizontal spacing between squares on the Gomoku board.") + "Horizontal spacing between squares on the Gomoku board.") (defconst gomoku-square-height 2 - "*Vertical spacing between squares on the Gomoku board.") + "Vertical spacing between squares on the Gomoku board.") (defconst gomoku-x-offset 3 - "*Number of columns between the Gomoku board and the side of the window.") + "Number of columns between the Gomoku board and the side of the window.") (defconst gomoku-y-offset 1 - "*Number of lines between the Gomoku board and the top of the window.") + "Number of lines between the Gomoku board and the top of the window.") (defvar gomoku-mode-map @@ -173,7 +173,7 @@ One useful value to include is `turn-on-font-lock' to highlight the pieces." '(("O" . 'gomoku-O) ("X" . 'gomoku-X) ("[-|/\\]" 0 (if gomoku-emacs-won 'gomoku-O 'gomoku-X))) - "*Font lock rules for Gomoku.") + "Font lock rules for Gomoku.") (put 'gomoku-mode 'front-sticky (put 'gomoku-mode 'rear-nonsticky '(intangible))) diff --git a/lisp/play/landmark.el b/lisp/play/landmark.el index 29bb8a40e8f..9ffc308928a 100644 --- a/lisp/play/landmark.el +++ b/lisp/play/landmark.el @@ -139,16 +139,16 @@ ;; look rectangular, but spacings SHOULD be at least 2 (MUST BE at least 1). (defconst landmark-square-width 2 - "*Horizontal spacing between squares on the Landmark board.") + "Horizontal spacing between squares on the Landmark board.") (defconst landmark-square-height 1 - "*Vertical spacing between squares on the Landmark board.") + "Vertical spacing between squares on the Landmark board.") (defconst landmark-x-offset 3 - "*Number of columns between the Landmark board and the side of the window.") + "Number of columns between the Landmark board and the side of the window.") (defconst landmark-y-offset 1 - "*Number of lines between the Landmark board and the top of the window.") + "Number of lines between the Landmark board and the top of the window.") ;;;_ + LANDMARK MODE AND KEYMAP. @@ -206,7 +206,7 @@ (defvar landmark-emacs-won () - "*For making font-lock use the winner's face for the line.") + "For making font-lock use the winner's face for the line.") (defface landmark-font-lock-face-O '((((class color)) :foreground "red") (t :weight bold)) @@ -226,7 +226,7 @@ ("[-|/\\]" 0 (if landmark-emacs-won 'landmark-font-lock-face-O 'landmark-font-lock-face-X))) - "*Font lock rules for Landmark.") + "Font lock rules for Landmark.") (put 'landmark-mode 'front-sticky (put 'landmark-mode 'rear-nonsticky '(intangible))) diff --git a/lisp/play/zone.el b/lisp/play/zone.el index f1d42aafb9c..f47e273d612 100644 --- a/lisp/play/zone.el +++ b/lisp/play/zone.el @@ -43,7 +43,7 @@ "The timer we use to decide when to zone out, or nil if none.") (defvar zone-timeout nil - "*Seconds to timeout the zoning. + "Seconds to timeout the zoning. If nil, don't interrupt for about 1^26 seconds.") ;; Vector of functions that zone out. `zone' will execute one of @@ -623,7 +623,7 @@ If the element is a function or a list of a function and a number, ;;;; the lyfe so short the craft so long to lerne --chaucer (defvar zone-pgm-random-life-wait nil - "*Seconds to wait between successive `life' generations. + "Seconds to wait between successive `life' generations. If nil, `zone-pgm-random-life' chooses a value from 0-3 (inclusive).") (defvar life-patterns) ; from life.el diff --git a/lisp/progmodes/ada-mode.el b/lisp/progmodes/ada-mode.el index d8768dd5986..33ff4645a77 100644 --- a/lisp/progmodes/ada-mode.el +++ b/lisp/progmodes/ada-mode.el @@ -139,7 +139,7 @@ version-string))) (defvar ada-mode-hook nil - "*List of functions to call when Ada mode is invoked. + "List of functions to call when Ada mode is invoked. This hook is automatically executed after the `ada-mode' is fully loaded. This is a good place to add Ada environment specific bindings.") @@ -150,13 +150,13 @@ This is a good place to add Ada environment specific bindings.") :group 'languages) (defcustom ada-auto-case t - "*Non-nil means automatically change case of preceding word while typing. + "Non-nil means automatically change case of preceding word while typing. Casing is done according to `ada-case-keyword', `ada-case-identifier' and `ada-case-attribute'." :type 'boolean :group 'ada) (defcustom ada-broken-decl-indent 0 - "*Number of columns to indent a broken declaration. + "Number of columns to indent a broken declaration. An example is : declare @@ -165,7 +165,7 @@ An example is : :type 'integer :group 'ada) (defcustom ada-broken-indent 2 - "*Number of columns to indent the continuation of a broken line. + "Number of columns to indent the continuation of a broken line. An example is : My_Var : My_Type := (Field1 => @@ -173,7 +173,7 @@ An example is : :type 'integer :group 'ada) (defcustom ada-continuation-indent ada-broken-indent - "*Number of columns to indent the continuation of broken lines in parenthesis. + "Number of columns to indent the continuation of broken lines in parenthesis. An example is : Func (Param1, @@ -181,7 +181,7 @@ An example is : :type 'integer :group 'ada) (defcustom ada-case-attribute 'ada-capitalize-word - "*Function to call to adjust the case of Ada attributes. + "Function to call to adjust the case of Ada attributes. It may be `downcase-word', `upcase-word', `ada-loose-case-word', `ada-capitalize-word' or `ada-no-auto-case'." :type '(choice (const downcase-word) @@ -193,7 +193,7 @@ It may be `downcase-word', `upcase-word', `ada-loose-case-word', (defcustom ada-case-exception-file (list (convert-standard-filename' "~/.emacs_case_exceptions")) - "*List of special casing exceptions dictionaries for identifiers. + "List of special casing exceptions dictionaries for identifiers. The first file is the one where new exceptions will be saved by Emacs when you call `ada-create-case-exception'. @@ -207,7 +207,7 @@ by a comment." :group 'ada) (defcustom ada-case-keyword 'downcase-word - "*Function to call to adjust the case of an Ada keywords. + "Function to call to adjust the case of an Ada keywords. It may be `downcase-word', `upcase-word', `ada-loose-case-word' or `ada-capitalize-word'." :type '(choice (const downcase-word) @@ -218,7 +218,7 @@ It may be `downcase-word', `upcase-word', `ada-loose-case-word' or :group 'ada) (defcustom ada-case-identifier 'ada-loose-case-word - "*Function to call to adjust the case of an Ada identifier. + "Function to call to adjust the case of an Ada identifier. It may be `downcase-word', `upcase-word', `ada-loose-case-word' or `ada-capitalize-word'." :type '(choice (const downcase-word) @@ -229,7 +229,7 @@ It may be `downcase-word', `upcase-word', `ada-loose-case-word' or :group 'ada) (defcustom ada-clean-buffer-before-saving t - "*Non-nil means remove trailing spaces and untabify the buffer before saving." + "Non-nil means remove trailing spaces and untabify the buffer before saving." :type 'boolean :group 'ada) (make-obsolete-variable 'ada-clean-buffer-before-saving "use the `write-file-functions' hook." @@ -237,7 +237,7 @@ It may be `downcase-word', `upcase-word', `ada-loose-case-word' or (defcustom ada-indent 3 - "*Size of Ada indentation. + "Size of Ada indentation. An example is : procedure Foo is @@ -246,11 +246,11 @@ begin :type 'integer :group 'ada) (defcustom ada-indent-after-return t - "*Non-nil means automatically indent after RET or LFD." + "Non-nil means automatically indent after RET or LFD." :type 'boolean :group 'ada) (defcustom ada-indent-align-comments t - "*Non-nil means align comments on previous line comments, if any. + "Non-nil means align comments on previous line comments, if any. If nil, indentation is calculated as usual. Note that indentation is calculated only if `ada-indent-comment-as-code' is t. @@ -260,12 +260,12 @@ For instance: :type 'boolean :group 'ada) (defcustom ada-indent-comment-as-code t - "*Non-nil means indent comment lines as code. + "Non-nil means indent comment lines as code. A nil value means do not auto-indent comments." :type 'boolean :group 'ada) (defcustom ada-indent-handle-comment-special nil - "*Non-nil if comment lines should be handled specially inside parenthesis. + "Non-nil if comment lines should be handled specially inside parenthesis. By default, if the line that contains the open parenthesis has some text following it, then the following lines will be indented in the same column as this text. This will not be true if the first line is @@ -287,11 +287,11 @@ type A is :type 'boolean :group 'ada) (defcustom ada-indent-is-separate t - "*Non-nil means indent 'is separate' or 'is abstract' if on a single line." + "Non-nil means indent 'is separate' or 'is abstract' if on a single line." :type 'boolean :group 'ada) (defcustom ada-indent-record-rel-type 3 - "*Indentation for 'record' relative to 'type' or 'use'. + "Indentation for 'record' relative to 'type' or 'use'. An example is: type A is @@ -299,7 +299,7 @@ An example is: :type 'integer :group 'ada) (defcustom ada-indent-renames ada-broken-indent - "*Indentation for renames relative to the matching function statement. + "Indentation for renames relative to the matching function statement. If `ada-indent-return' is null or negative, the indentation is done relative to the open parenthesis (if there is no parenthesis, `ada-broken-indent' is used). @@ -310,7 +310,7 @@ An example is: :type 'integer :group 'ada) (defcustom ada-indent-return 0 - "*Indentation for 'return' relative to the matching 'function' statement. + "Indentation for 'return' relative to the matching 'function' statement. If `ada-indent-return' is null or negative, the indentation is done relative to the open parenthesis (if there is no parenthesis, `ada-broken-indent' is used). @@ -320,22 +320,22 @@ An example is: :type 'integer :group 'ada) (defcustom ada-indent-to-open-paren t - "*Non-nil means indent according to the innermost open parenthesis." + "Non-nil means indent according to the innermost open parenthesis." :type 'boolean :group 'ada) (defcustom ada-fill-comment-prefix "-- " - "*Text inserted in the first columns when filling a comment paragraph. + "Text inserted in the first columns when filling a comment paragraph. Note: if you modify this variable, you will have to invoke `ada-mode' again to take account of the new value." :type 'string :group 'ada) (defcustom ada-fill-comment-postfix " --" - "*Text inserted at the end of each line when filling a comment paragraph. + "Text inserted at the end of each line when filling a comment paragraph. Used by `ada-fill-comment-paragraph-postfix'." :type 'string :group 'ada) (defcustom ada-label-indent -4 - "*Number of columns to indent a label. + "Number of columns to indent a label. An example is: procedure Foo is @@ -346,15 +346,15 @@ This is also used for <<..>> labels" :type 'integer :group 'ada) (defcustom ada-language-version 'ada95 - "*Ada language version; one of `ada83', `ada95', `ada2005'." + "Ada language version; one of `ada83', `ada95', `ada2005'." :type '(choice (const ada83) (const ada95) (const ada2005)) :group 'ada) (defcustom ada-move-to-declaration nil - "*Non-nil means `ada-move-to-start' moves to the subprogram declaration, not to 'begin'." + "Non-nil means `ada-move-to-start' moves to the subprogram declaration, not to 'begin'." :type 'boolean :group 'ada) (defcustom ada-popup-key '[down-mouse-3] - "*Key used for binding the contextual menu. + "Key used for binding the contextual menu. If nil, no contextual menu is available." :type '(restricted-sexp :match-alternatives (stringp vectorp)) :group 'ada) @@ -364,7 +364,7 @@ If nil, no contextual menu is available." (split-string (or (getenv "ADA_INCLUDE_PATH") "") ":") '("/usr/adainclude" "/usr/local/adainclude" "/opt/gnu/adainclude")) - "*Default list of directories to search for Ada files. + "Default list of directories to search for Ada files. See the description for the `ff-search-directories' variable. This variable is the initial value of `ada-search-directories-internal'." :type '(repeat (choice :tag "Directory" @@ -379,7 +379,7 @@ and the standard runtime location, and the value of the user-defined `ada-search-directories'.") (defcustom ada-stmt-end-indent 0 - "*Number of columns to indent the end of a statement on a separate line. + "Number of columns to indent the end of a statement on a separate line. An example is: if A = B @@ -387,7 +387,7 @@ An example is: :type 'integer :group 'ada) (defcustom ada-tab-policy 'indent-auto - "*Control the behavior of the TAB key. + "Control the behavior of the TAB key. Must be one of : `indent-rigidly' : always adds `ada-indent' blanks at the beginning of the line. `indent-auto' : use indentation functions in this file. @@ -398,7 +398,7 @@ Must be one of : :group 'ada) (defcustom ada-use-indent ada-broken-indent - "*Indentation for the lines in a 'use' statement. + "Indentation for the lines in a 'use' statement. An example is: use Ada.Text_IO, @@ -406,7 +406,7 @@ An example is: :type 'integer :group 'ada) (defcustom ada-when-indent 3 - "*Indentation for 'when' relative to 'exception' or 'case'. + "Indentation for 'when' relative to 'exception' or 'case'. An example is: case A is @@ -414,7 +414,7 @@ An example is: :type 'integer :group 'ada) (defcustom ada-with-indent ada-broken-indent - "*Indentation for the lines in a 'with' statement. + "Indentation for the lines in a 'with' statement. An example is: with Ada.Text_IO, @@ -422,7 +422,7 @@ An example is: :type 'integer :group 'ada) (defcustom ada-which-compiler 'gnat - "*Name of the compiler to use. + "Name of the compiler to use. This will determine what features are made available through the Ada mode. The possible choices are: `gnat': Use Ada Core Technologies' GNAT compiler. Add some cross-referencing diff --git a/lisp/progmodes/ada-xref.el b/lisp/progmodes/ada-xref.el index 1e07ac4cf09..146cc703e1a 100644 --- a/lisp/progmodes/ada-xref.el +++ b/lisp/progmodes/ada-xref.el @@ -50,21 +50,21 @@ ;; ------ User variables (defcustom ada-xref-other-buffer t - "*If nil, always display the cross-references in the same buffer. + "If nil, always display the cross-references in the same buffer. Otherwise create either a new buffer or a new frame." :type 'boolean :group 'ada) (defcustom ada-xref-create-ali nil - "*If non-nil, run gcc whenever the cross-references are not up-to-date. + "If non-nil, run gcc whenever the cross-references are not up-to-date. If nil, the cross-reference mode never runs gcc." :type 'boolean :group 'ada) (defcustom ada-xref-confirm-compile nil - "*If non-nil, ask for confirmation before compiling or running the application." + "If non-nil, ask for confirmation before compiling or running the application." :type 'boolean :group 'ada) (defcustom ada-krunch-args "0" - "*Maximum number of characters for filenames created by `gnatkr'. + "Maximum number of characters for filenames created by `gnatkr'. Set to 0, if you don't use crunched filenames. This should be a string." :type 'string :group 'ada) @@ -76,7 +76,7 @@ is faster, available from Ada mode web site." :type 'string :group 'ada) (defcustom ada-gnatls-args '("-v") - "*Arguments to pass to `gnatls' to find location of the runtime. + "Arguments to pass to `gnatls' to find location of the runtime. Typical use is to pass `--RTS=soft-floats' on some systems that support it. You can also add `-I-' if you do not want the current directory to be included. @@ -125,7 +125,7 @@ The command `gnatfind' is used every time you choose the menu (defcustom ada-prj-default-check-cmd (concat "${cross_prefix}gnatmake -u -c -gnatc ${gnatmake_opt} ${full_current}" " -cargs ${comp_opt}") - "*Default command to be used to compile a single file. + "Default command to be used to compile a single file. Emacs will substitute the current filename for ${full_current}, or add the filename at the end. This is the same syntax as in the project file." :type 'string :group 'ada) @@ -133,35 +133,35 @@ the filename at the end. This is the same syntax as in the project file." (defcustom ada-prj-default-comp-cmd (concat "${cross_prefix}gnatmake -u -c ${gnatmake_opt} ${full_current} -cargs" " ${comp_opt}") - "*Default command to be used to compile a single file. + "Default command to be used to compile a single file. Emacs will substitute the current filename for ${full_current}, or add the filename at the end. This is the same syntax as in the project file." :type 'string :group 'ada) (defcustom ada-prj-default-debugger "${cross_prefix}gdb" - "*Default name of the debugger." + "Default name of the debugger." :type 'string :group 'ada) (defcustom ada-prj-default-make-cmd (concat "${cross_prefix}gnatmake -o ${main} ${main} ${gnatmake_opt} " "-cargs ${comp_opt} -bargs ${bind_opt} -largs ${link_opt}") - "*Default command to be used to compile the application. + "Default command to be used to compile the application. This is the same syntax as in the project file." :type 'string :group 'ada) (defcustom ada-prj-default-project-file "" - "*Name of the current project file. + "Name of the current project file. Emacs will not try to use the search algorithm to find the project file if this string is not empty. It is set whenever a project file is found." :type '(file :must-match t) :group 'ada) (defcustom ada-gnatstub-opts "-q -I${src_dir}" - "*Options to pass to `gnatsub' to generate the body of a package. + "Options to pass to `gnatsub' to generate the body of a package. This has the same syntax as in the project file (with variable substitution)." :type 'string :group 'ada) (defcustom ada-always-ask-project nil - "*If nil, use default values when no project file was found. + "If nil, use default values when no project file was found. Otherwise, ask the user for the name of the project file to use." :type 'boolean :group 'ada) @@ -169,12 +169,12 @@ Otherwise, ask the user for the name of the project file to use." "True if we are running on Windows.") (defcustom ada-tight-gvd-integration nil - "*If non-nil, a new Emacs frame will be swallowed in GVD when debugging. + "If non-nil, a new Emacs frame will be swallowed in GVD when debugging. If GVD is not the debugger used, nothing happens." :type 'boolean :group 'ada) (defcustom ada-xref-search-with-egrep t - "*If non-nil, use egrep to find the possible declarations for an entity. + "If non-nil, use egrep to find the possible declarations for an entity. This alternate method is used when the exact location was not found in the information provided by GNAT. However, it might be expensive if you have a lot of sources, since it will search in all the files in your project." diff --git a/lisp/progmodes/antlr-mode.el b/lisp/progmodes/antlr-mode.el index 9c9a8e09d49..345ca563906 100644 --- a/lisp/progmodes/antlr-mode.el +++ b/lisp/progmodes/antlr-mode.el @@ -269,7 +269,7 @@ greater than this number." (integer :tag "Hidden if longer than" :value 3))) (defcustom antlr-indent-comment 'tab - "*Non-nil, if the indentation should touch lines in block comments. + "Non-nil, if the indentation should touch lines in block comments. If nil, no continuation line of a block comment is changed. If t, they are changed according to `c-indentation-line'. When not nil and not t, they are only changed by \\[antlr-indent-command]." @@ -296,7 +296,7 @@ ANTLR's and Java's indentation styles. Used by `antlr-set-tabs'." (boolean :tag "Indent-tabs-mode")))) (defcustom antlr-indent-style "java" - "*If non-nil, cc-mode indentation style used for `antlr-mode'. + "If non-nil, cc-mode indentation style used for `antlr-mode'. See `c-set-style' and for details, where the most interesting part in `c-style-alist' is the value of `c-basic-offset'." :group 'antlr @@ -339,14 +339,14 @@ to the normal rules of `antlr-indent-line'." ;;;=========================================================================== (defcustom antlr-options-use-submenus t - "*Non-nil, if the major mode menu should include option submenus. + "Non-nil, if the major mode menu should include option submenus. If nil, the menu just includes a command to insert options. Otherwise, it includes four submenus to insert file/grammar/rule/subrule options." :group 'antlr :type 'boolean) (defcustom antlr-tool-version 20701 - "*The version number of the Antlr tool. + "The version number of the Antlr tool. The value is an integer of the form XYYZZ which stands for vX.YY.ZZ. This variable is used to warn about non-supported options and to supply version correct option values when using \\[antlr-insert-option]. @@ -358,7 +358,7 @@ can make this variable buffer-local." :type 'integer) (defcustom antlr-options-auto-colon t - "*Non-nil, if `:' is inserted with a rule or subrule options section. + "Non-nil, if `:' is inserted with a rule or subrule options section. A `:' is only inserted if this value is non-nil, if a rule or subrule option is inserted with \\[antlr-insert-option], if there was no rule or subrule options section before, and if a `:' is not already present @@ -378,7 +378,7 @@ is `language-as-string'. See also `antlr-read-value'." :type '(repeat (symbol :tag "Style symbol"))) (defcustom antlr-options-push-mark t - "*Non-nil, if inserting an option should set & push mark. + "Non-nil, if inserting an option should set & push mark. If nil, never set mark when inserting an option with command \\[antlr-insert-option]. If t, always set mark via `push-mark'. If a number, only set mark if point was outside the options area before and @@ -392,7 +392,7 @@ options area before." (sexp :tag "If outside options" :format "%t" :value outside))) (defcustom antlr-options-assign-string " = " - "*String containing `=' to use between option name and value. + "String containing `=' to use between option name and value. This string is only used if the option to insert did not exist before or if there was no `=' after it. In other words, the spacing around an existing `=' won't be changed when changing an option value." @@ -578,21 +578,21 @@ AS-STRING is non-nil and is either t or a symbol which is a member of ;;;=========================================================================== (defcustom antlr-tool-command "java antlr.Tool" - "*Command used in \\[antlr-run-tool] to run the Antlr tool. + "Command used in \\[antlr-run-tool] to run the Antlr tool. This variable should include all options passed to Antlr except the option \"-glib\" which is automatically suggested if necessary." :group 'antlr :type 'string) (defcustom antlr-ask-about-save t - "*If not nil, \\[antlr-run-tool] asks which buffers to save. + "If not nil, \\[antlr-run-tool] asks which buffers to save. Otherwise, it saves all modified buffers before running without asking." :group 'antlr :type 'boolean) (defcustom antlr-makefile-specification '("\n" ("GENS" "GENS%d" " \\\n\t") "$(ANTLR)") - "*Variable to specify the appearance of the generated makefile rules. + "Variable to specify the appearance of the generated makefile rules. This variable influences the output of \\[antlr-show-makefile-rules]. It looks like \(RULE-SEP GEN-VAR-SPEC COMMAND). @@ -650,7 +650,7 @@ See variable `antlr-file-formats-alist' for language dependent formats.") (defvar antlr-unknown-file-formats '("?%s?.g" "?%s?") - "*Formats which specify the names of unknown files. + "Formats which specify the names of unknown files. The value looks like \(SUPER-GRAMMAR-FILE-FORMAT SUPER-EVOCAB-FORMAT). SUPER-GRAMMAR-FORMAT is a format string, it specifies with substitution @@ -685,7 +685,7 @@ DIRECTORY is the name of the current directory.") ;;;=========================================================================== (defcustom antlr-imenu-name t ; (featurep 'xemacs) ; TODO: Emacs-21 bug? - "*Non-nil, if a \"Index\" menu should be added to the menubar. + "Non-nil, if a \"Index\" menu should be added to the menubar. If it is a string, it is used instead \"Index\". Requires package imenu." :group 'antlr @@ -774,7 +774,7 @@ imenu." ;;;=========================================================================== (defcustom antlr-font-lock-maximum-decoration 'inherit - "*The maximum decoration level for fontifying actions. + "The maximum decoration level for fontifying actions. Value `none' means, do not fontify actions, just normal grammar code according to `antlr-font-lock-additional-keywords'. Value `inherit' means, use value of `font-lock-maximum-decoration'. Any other value is diff --git a/lisp/progmodes/asm-mode.el b/lisp/progmodes/asm-mode.el index cfa977d9022..5e15371b406 100644 --- a/lisp/progmodes/asm-mode.el +++ b/lisp/progmodes/asm-mode.el @@ -53,7 +53,7 @@ :group 'languages) (defcustom asm-comment-char ?\; - "*The comment-start character assumed by Asm mode." + "The comment-start character assumed by Asm mode." :type 'character :group 'asm) diff --git a/lisp/progmodes/cfengine.el b/lisp/progmodes/cfengine.el index 4e9a10e3ceb..64e99fb1f3d 100644 --- a/lisp/progmodes/cfengine.el +++ b/lisp/progmodes/cfengine.el @@ -54,7 +54,7 @@ :group 'languages) (defcustom cfengine-indent 2 - "*Size of a CFEngine indentation step in columns." + "Size of a CFEngine indentation step in columns." :group 'cfengine :type 'integer) diff --git a/lisp/progmodes/cmacexp.el b/lisp/progmodes/cmacexp.el index 88c36e8c452..0feefd99715 100644 --- a/lisp/progmodes/cmacexp.el +++ b/lisp/progmodes/cmacexp.el @@ -106,12 +106,12 @@ (defcustom c-macro-shrink-window-flag nil - "*Non-nil means shrink the *Macroexpansion* window to fit its contents." + "Non-nil means shrink the *Macroexpansion* window to fit its contents." :type 'boolean :group 'c-macro) (defcustom c-macro-prompt-flag nil - "*Non-nil makes `c-macro-expand' prompt for preprocessor arguments." + "Non-nil makes `c-macro-expand' prompt for preprocessor arguments." :type 'boolean :group 'c-macro) @@ -141,7 +141,7 @@ option, or to set an equivalent one." :group 'c-macro) (defcustom c-macro-cppflags "" - "*Preprocessor flags used by `c-macro-expand'." + "Preprocessor flags used by `c-macro-expand'." :type 'string :group 'c-macro) diff --git a/lisp/progmodes/compile.el b/lisp/progmodes/compile.el index c1d8f9db23f..2608ba0b0c3 100644 --- a/lisp/progmodes/compile.el +++ b/lisp/progmodes/compile.el @@ -78,7 +78,7 @@ after `call-process' inserts the grep output into the buffer.") This is bound before running `compilation-filter-hook'.") (defvar compilation-first-column 1 - "*This is how compilers number the first column, usually 1 or 0. + "This is how compilers number the first column, usually 1 or 0. If this is buffer-local in the destination buffer, Emacs obeys that value, otherwise it uses the value in the *compilation* buffer. This enables a major-mode to specify its own value.") @@ -90,7 +90,7 @@ in the compilation output, and should return a transformed file name.") ;;;###autoload (defvar compilation-process-setup-function nil - "*Function to call to customize the compilation process. + "Function to call to customize the compilation process. This function is called immediately before the compilation process is started. It can be used to set any variables or functions that are used while processing the output of the compilation process.") @@ -633,7 +633,7 @@ This only affects platforms that support asynchronous processes (see (defvar compilation-locs ()) (defvar compilation-debug nil - "*Set this to t before creating a *compilation* buffer. + "Set this to t before creating a *compilation* buffer. Then every error line will have a debug text property with the matcher that fit this line and the match data. Use `describe-text-properties'.") @@ -739,7 +739,7 @@ Faces `compilation-error-face', `compilation-warning-face', ;; (make-variable-buffer-local 'compilation-buffer-modtime) (defvar compilation-skip-to-next-location t - "*If non-nil, skip multiple error messages for the same source location.") + "If non-nil, skip multiple error messages for the same source location.") (defcustom compilation-skip-threshold 1 "Compilation motion commands skip less important messages. diff --git a/lisp/progmodes/cpp.el b/lisp/progmodes/cpp.el index 8ecfe79de3b..1b36fe2800d 100644 --- a/lisp/progmodes/cpp.el +++ b/lisp/progmodes/cpp.el @@ -52,7 +52,7 @@ :prefix "cpp-") (defcustom cpp-config-file (convert-standard-filename ".cpp.el") - "*File name to save cpp configuration." + "File name to save cpp configuration." :type 'file :group 'cpp) @@ -61,17 +61,17 @@ :type '(choice (const invisible) (face))) (defcustom cpp-known-face 'invisible - "*Face used for known cpp symbols." + "Face used for known cpp symbols." :type 'cpp-face :group 'cpp) (defcustom cpp-unknown-face 'highlight - "*Face used for unknown cpp symbols." + "Face used for unknown cpp symbols." :type 'cpp-face :group 'cpp) (defcustom cpp-face-type 'light - "*Indicate what background face type you prefer. + "Indicate what background face type you prefer. Can be either light or dark for color screens, mono for monochrome screens, and none if you don't use a window system and don't have a color-capable display." @@ -80,12 +80,12 @@ a color-capable display." :group 'cpp) (defcustom cpp-known-writable t - "*Non-nil means you are allowed to modify the known conditionals." + "Non-nil means you are allowed to modify the known conditionals." :type 'boolean :group 'cpp) (defcustom cpp-unknown-writable t - "*Non-nil means you are allowed to modify the unknown conditionals." + "Non-nil means you are allowed to modify the unknown conditionals." :type 'boolean :group 'cpp) diff --git a/lisp/progmodes/cwarn.el b/lisp/progmodes/cwarn.el index 74ca5a6d76f..3e99f3c9176 100644 --- a/lisp/progmodes/cwarn.el +++ b/lisp/progmodes/cwarn.el @@ -120,7 +120,7 @@ :group 'faces) (defvar cwarn-mode nil - "*Non-nil when Cwarn mode is active. + "Non-nil when Cwarn mode is active. Never set this variable directly, use the command `cwarn-mode' instead.") diff --git a/lisp/progmodes/dcl-mode.el b/lisp/progmodes/dcl-mode.el index 166065131b2..af0ae9d1123 100644 --- a/lisp/progmodes/dcl-mode.el +++ b/lisp/progmodes/dcl-mode.el @@ -98,7 +98,7 @@ Presently this includes some syntax, .OP.erators, and \"f$\" lexicals.") :group 'languages) (defcustom dcl-basic-offset 4 - "*Number of columns to indent a block in DCL. + "Number of columns to indent a block in DCL. A block is the commands between THEN-ELSE-ENDIF and between the commands dcl-block-begin-regexp and dcl-block-end-regexp. @@ -109,7 +109,7 @@ dcl-calc-command-indent-function is set to a function." (defcustom dcl-continuation-offset 6 - "*Number of columns to indent a continuation line in DCL. + "Number of columns to indent a continuation line in DCL. A continuation line is a line that follows a line ending with `-'. The meaning of this variable may be changed if @@ -119,7 +119,7 @@ dcl-calc-cont-indent-function is set to a function." (defcustom dcl-margin-offset 8 - "*Indentation for the first command line in DCL. + "Indentation for the first command line in DCL. The first command line in a file or after a SUBROUTINE statement is indented this much. Other command lines are indented the same number of columns as the preceding command line. @@ -129,7 +129,7 @@ A command line is a line that starts with `$'." (defcustom dcl-margin-label-offset 2 - "*Number of columns to indent a margin label in DCL. + "Number of columns to indent a margin label in DCL. A margin label is a label that doesn't begin or end a block, i.e. it doesn't match dcl-block-begin-regexp or dcl-block-end-regexp." :type 'integer @@ -137,28 +137,28 @@ doesn't match dcl-block-begin-regexp or dcl-block-end-regexp." (defcustom dcl-comment-line-regexp "^\\$!" - "*Regexp describing the start of a comment line in DCL. + "Regexp describing the start of a comment line in DCL. Comment lines are not indented." :type 'regexp :group 'dcl) (defcustom dcl-block-begin-regexp "loop[0-9]*:" - "*Regexp describing a command that begins an indented block in DCL. + "Regexp describing a command that begins an indented block in DCL. Set to nil to only indent at THEN-ELSE-ENDIF." :type 'regexp :group 'dcl) (defcustom dcl-block-end-regexp "endloop[0-9]*:" - "*Regexp describing a command that ends an indented block in DCL. + "Regexp describing a command that ends an indented block in DCL. Set to nil to only indent at THEN-ELSE-ENDIF." :type 'regexp :group 'dcl) (defcustom dcl-calc-command-indent-function nil - "*Function to calculate indentation for a command line in DCL. + "Function to calculate indentation for a command line in DCL. If this variable is non-nil it is called as a function: \(func INDENT-TYPE CUR-INDENT EXTRA-INDENT LAST-POINT THIS-POINT) @@ -190,7 +190,7 @@ This package includes two functions suitable for this: (defcustom dcl-calc-cont-indent-function 'dcl-calc-cont-indent-relative - "*Function to calculate indentation for a continuation line. + "Function to calculate indentation for a continuation line. If this variable is non-nil it is called as a function: \(func CUR-INDENT EXTRA-INDENT) @@ -208,7 +208,7 @@ This package includes one function suitable for this: (defcustom dcl-tab-always-indent t - "*Controls the operation of the TAB key in DCL mode. + "Controls the operation of the TAB key in DCL mode. If t, pressing TAB always indents the current line. If nil, pressing TAB indents the current line if point is at the left margin. Data lines (i.e. lines not part of a command line or continuation line) are @@ -218,43 +218,43 @@ never indented." (defcustom dcl-electric-characters t - "*Non-nil means reindent immediately when a label, ELSE or ENDIF is inserted." + "Non-nil means reindent immediately when a label, ELSE or ENDIF is inserted." :type 'boolean :group 'dcl) (defcustom dcl-tempo-comma ", " - "*Text to insert when a comma is needed in a template, in DCL mode." + "Text to insert when a comma is needed in a template, in DCL mode." :type 'string :group 'dcl) (defcustom dcl-tempo-left-paren "(" - "*Text to insert when a left parenthesis is needed in a template in DCL." + "Text to insert when a left parenthesis is needed in a template in DCL." :type 'string :group 'dcl) (defcustom dcl-tempo-right-paren ")" - "*Text to insert when a right parenthesis is needed in a template in DCL." + "Text to insert when a right parenthesis is needed in a template in DCL." :type 'string :group 'dcl) ; I couldn't decide what looked best, so I'll let you decide... ; Remember, you can also customize this with imenu-submenu-name-format. (defcustom dcl-imenu-label-labels "Labels" - "*Imenu menu title for sub-listing with label names." + "Imenu menu title for sub-listing with label names." :type 'string :group 'dcl) (defcustom dcl-imenu-label-goto "GOTO" - "*Imenu menu title for sub-listing with GOTO statements." + "Imenu menu title for sub-listing with GOTO statements." :type 'string :group 'dcl) (defcustom dcl-imenu-label-gosub "GOSUB" - "*Imenu menu title for sub-listing with GOSUB statements." + "Imenu menu title for sub-listing with GOSUB statements." :type 'string :group 'dcl) (defcustom dcl-imenu-label-call "CALL" - "*Imenu menu title for sub-listing with CALL statements." + "Imenu menu title for sub-listing with CALL statements." :type 'string :group 'dcl) @@ -265,7 +265,7 @@ never indented." (,dcl-imenu-label-goto "\\s-GOTO[ \t]+\\([A-Za-z0-9_\$]+\\)" 1) (,dcl-imenu-label-gosub "\\s-GOSUB[ \t]+\\([A-Za-z0-9_\$]+\\)" 1) (,dcl-imenu-label-call "\\s-CALL[ \t]+\\([A-Za-z0-9_\$]+\\)" 1)) - "*Default imenu generic expression for DCL. + "Default imenu generic expression for DCL. The default includes SUBROUTINE labels in the main listing and sub-listings for other labels, CALL, GOTO and GOSUB statements. @@ -275,7 +275,7 @@ See `imenu-generic-expression' for details." (defcustom dcl-mode-hook nil - "*Hook called by `dcl-mode'." + "Hook called by `dcl-mode'." :type 'hook :group 'dcl) @@ -400,7 +400,7 @@ optionally followed by a comment, followed by a newline." (defcustom dcl-electric-reindent-regexps (list "endif" "else" dcl-label-r) - "*Regexps that can trigger an electric reindent. + "Regexps that can trigger an electric reindent. A list of regexps that will trigger a reindent if the last letter is defined as dcl-electric-character. diff --git a/lisp/progmodes/delphi.el b/lisp/progmodes/delphi.el index dd8d267683c..d533135c70d 100644 --- a/lisp/progmodes/delphi.el +++ b/lisp/progmodes/delphi.el @@ -74,7 +74,7 @@ "True if in debug mode.") (defcustom delphi-search-path "." - "*Directories to search when finding external units. + "Directories to search when finding external units. It is a list of directory strings. If only a single directory, it can be a single string instead of a list. If a directory ends in \"...\" then that directory is recursively searched." @@ -82,7 +82,7 @@ ends in \"...\" then that directory is recursively searched." :group 'delphi) (defcustom delphi-indent-level 3 - "*Indentation of Delphi statements with respect to containing block. + "Indentation of Delphi statements with respect to containing block. E.g. begin @@ -92,7 +92,7 @@ end;" :group 'delphi) (defcustom delphi-compound-block-indent 0 - "*Extra indentation for blocks in compound statements. E.g. + "Extra indentation for blocks in compound statements. E.g. // block indent = 0 vs // block indent = 2 if b then if b then @@ -105,7 +105,7 @@ end; else :group 'delphi) (defcustom delphi-case-label-indent delphi-indent-level - "*Extra indentation for case statement labels. E.g. + "Extra indentation for case statement labels. E.g. // case indent = 0 vs // case indent = 3 case value of case value of @@ -118,18 +118,18 @@ end; end;" :group 'delphi) (defcustom delphi-verbose t ; nil - "*If true then Delphi token processing progress is reported to the user." + "If true then Delphi token processing progress is reported to the user." :type 'boolean :group 'delphi) (defcustom delphi-tab-always-indents t - "*Non-nil means TAB in Delphi mode should always reindent the current line, + "Non-nil means TAB in Delphi mode should always reindent the current line, regardless of where in the line point is when the TAB command is used." :type 'boolean :group 'delphi) (defcustom delphi-newline-always-indents t - "*Non-nil means NEWLINE in Delphi mode should always reindent the current + "Non-nil means NEWLINE in Delphi mode should always reindent the current line, insert a blank line and move to the default indent column of the blank line. If nil, then no indentation occurs, and NEWLINE does the usual behavior. This is useful when one needs to do customized indentation that @@ -138,22 +138,22 @@ differs from the default." :group 'delphi) (defcustom delphi-comment-face 'font-lock-comment-face - "*Face used to color Delphi comments." + "Face used to color Delphi comments." :type 'face :group 'delphi) (defcustom delphi-string-face 'font-lock-string-face - "*Face used to color Delphi strings." + "Face used to color Delphi strings." :type 'face :group 'delphi) (defcustom delphi-keyword-face 'font-lock-keyword-face - "*Face used to color Delphi keywords." + "Face used to color Delphi keywords." :type 'face :group 'delphi) (defcustom delphi-other-face nil - "*Face used to color everything else." + "Face used to color everything else." :type '(choice (const :tag "None" nil) face) :group 'delphi) diff --git a/lisp/progmodes/ebnf2ps.el b/lisp/progmodes/ebnf2ps.el index 5d0bfad0366..05c9e160ceb 100644 --- a/lisp/progmodes/ebnf2ps.el +++ b/lisp/progmodes/ebnf2ps.el @@ -1276,14 +1276,14 @@ Elements of ALIST that are not conses are ignored." (defcustom ebnf-horizontal-orientation nil - "*Non-nil means productions are drawn horizontally." + "Non-nil means productions are drawn horizontally." :type 'boolean :version "20" :group 'ebnf-displacement) (defcustom ebnf-horizontal-max-height nil - "*Non-nil means to use maximum production height in horizontal orientation. + "Non-nil means to use maximum production height in horizontal orientation. It is only used when `ebnf-horizontal-orientation' is non-nil." :type 'boolean @@ -1292,7 +1292,7 @@ It is only used when `ebnf-horizontal-orientation' is non-nil." (defcustom ebnf-production-horizontal-space 0.0 ; use ebnf2ps default value - "*Specify horizontal space in points between productions. + "Specify horizontal space in points between productions. Value less or equal to zero forces ebnf2ps to set a proper default value." :type 'number @@ -1301,7 +1301,7 @@ Value less or equal to zero forces ebnf2ps to set a proper default value." (defcustom ebnf-production-vertical-space 0.0 ; use ebnf2ps default value - "*Specify vertical space in points between productions. + "Specify vertical space in points between productions. Value less or equal to zero forces ebnf2ps to set a proper default value." :type 'number @@ -1310,7 +1310,7 @@ Value less or equal to zero forces ebnf2ps to set a proper default value." (defcustom ebnf-justify-sequence 'center - "*Specify justification of terms in a sequence inside alternatives. + "Specify justification of terms in a sequence inside alternatives. Valid values are: @@ -1324,14 +1324,14 @@ Valid values are: (defcustom ebnf-special-show-delimiter t - "*Non-nil means special delimiter (character `?') is shown." + "Non-nil means special delimiter (character `?') is shown." :type 'boolean :version "20" :group 'ebnf-special) (defcustom ebnf-special-font '(7 Courier "Black" "Gray95" bold italic) - "*Specify special font. + "Specify special font. See documentation for `ebnf-production-font'." :type '(list :tag "Special Font" @@ -1353,7 +1353,7 @@ See documentation for `ebnf-production-font'." (defcustom ebnf-special-shape 'bevel - "*Specify special box shape. + "Specify special box shape. See documentation for `ebnf-non-terminal-shape'." :type '(radio :tag "Special Shape" @@ -1363,28 +1363,28 @@ See documentation for `ebnf-non-terminal-shape'." (defcustom ebnf-special-shadow nil - "*Non-nil means special box will have a shadow." + "Non-nil means special box will have a shadow." :type 'boolean :version "20" :group 'ebnf-special) (defcustom ebnf-special-border-width 0.5 - "*Specify border width for special box." + "Specify border width for special box." :type 'number :version "20" :group 'ebnf-special) (defcustom ebnf-special-border-color "Black" - "*Specify border color for special box." + "Specify border color for special box." :type 'string :version "20" :group 'ebnf-special) (defcustom ebnf-except-font '(7 Courier "Black" "Gray90" bold italic) - "*Specify except font. + "Specify except font. See documentation for `ebnf-production-font'." :type '(list :tag "Except Font" @@ -1406,7 +1406,7 @@ See documentation for `ebnf-production-font'." (defcustom ebnf-except-shape 'bevel - "*Specify except box shape. + "Specify except box shape. See documentation for `ebnf-non-terminal-shape'." :type '(radio :tag "Except Shape" @@ -1416,28 +1416,28 @@ See documentation for `ebnf-non-terminal-shape'." (defcustom ebnf-except-shadow nil - "*Non-nil means except box will have a shadow." + "Non-nil means except box will have a shadow." :type 'boolean :version "20" :group 'ebnf-except) (defcustom ebnf-except-border-width 0.25 - "*Specify border width for except box." + "Specify border width for except box." :type 'number :version "20" :group 'ebnf-except) (defcustom ebnf-except-border-color "Black" - "*Specify border color for except box." + "Specify border color for except box." :type 'string :version "20" :group 'ebnf-except) (defcustom ebnf-repeat-font '(7 Courier "Black" "Gray85" bold italic) - "*Specify repeat font. + "Specify repeat font. See documentation for `ebnf-production-font'." :type '(list :tag "Repeat Font" @@ -1459,7 +1459,7 @@ See documentation for `ebnf-production-font'." (defcustom ebnf-repeat-shape 'bevel - "*Specify repeat box shape. + "Specify repeat box shape. See documentation for `ebnf-non-terminal-shape'." :type '(radio :tag "Repeat Shape" @@ -1469,28 +1469,28 @@ See documentation for `ebnf-non-terminal-shape'." (defcustom ebnf-repeat-shadow nil - "*Non-nil means repeat box will have a shadow." + "Non-nil means repeat box will have a shadow." :type 'boolean :version "20" :group 'ebnf-repeat) (defcustom ebnf-repeat-border-width 0.0 - "*Specify border width for repeat box." + "Specify border width for repeat box." :type 'number :version "20" :group 'ebnf-repeat) (defcustom ebnf-repeat-border-color "Black" - "*Specify border color for repeat box." + "Specify border color for repeat box." :type 'string :version "20" :group 'ebnf-repeat) (defcustom ebnf-terminal-font '(7 Courier "Black" "White") - "*Specify terminal font. + "Specify terminal font. See documentation for `ebnf-production-font'." :type '(list :tag "Terminal Font" @@ -1512,7 +1512,7 @@ See documentation for `ebnf-production-font'." (defcustom ebnf-terminal-shape 'miter - "*Specify terminal box shape. + "Specify terminal box shape. See documentation for `ebnf-non-terminal-shape'." :type '(radio :tag "Terminal Shape" @@ -1522,35 +1522,35 @@ See documentation for `ebnf-non-terminal-shape'." (defcustom ebnf-terminal-shadow nil - "*Non-nil means terminal box will have a shadow." + "Non-nil means terminal box will have a shadow." :type 'boolean :version "20" :group 'ebnf-terminal) (defcustom ebnf-terminal-border-width 1.0 - "*Specify border width for terminal box." + "Specify border width for terminal box." :type 'number :version "20" :group 'ebnf-terminal) (defcustom ebnf-terminal-border-color "Black" - "*Specify border color for terminal box." + "Specify border color for terminal box." :type 'string :version "20" :group 'ebnf-terminal) (defcustom ebnf-production-name-p t - "*Non-nil means production name will be printed." + "Non-nil means production name will be printed." :type 'boolean :version "20" :group 'ebnf-production) (defcustom ebnf-sort-production nil - "*Specify how productions are sorted. + "Specify how productions are sorted. Valid values are: @@ -1566,7 +1566,7 @@ Valid values are: (defcustom ebnf-production-font '(10 Helvetica "Black" "White" bold) - "*Specify production header font. + "Specify production header font. It is a list with the following form: @@ -1609,7 +1609,7 @@ See `ps-font-info-database' for valid font name." (defcustom ebnf-non-terminal-font '(7 Helvetica "Black" "White") - "*Specify non-terminal font. + "Specify non-terminal font. See documentation for `ebnf-production-font'." :type '(list :tag "Non-Terminal Font" @@ -1631,7 +1631,7 @@ See documentation for `ebnf-production-font'." (defcustom ebnf-non-terminal-shape 'round - "*Specify non-terminal box shape. + "Specify non-terminal box shape. Valid values are: @@ -1655,28 +1655,28 @@ Any other value is treated as `miter'." (defcustom ebnf-non-terminal-shadow nil - "*Non-nil means non-terminal box will have a shadow." + "Non-nil means non-terminal box will have a shadow." :type 'boolean :version "20" :group 'ebnf-non-terminal) (defcustom ebnf-non-terminal-border-width 1.0 - "*Specify border width for non-terminal box." + "Specify border width for non-terminal box." :type 'number :version "20" :group 'ebnf-non-terminal) (defcustom ebnf-non-terminal-border-color "Black" - "*Specify border color for non-terminal box." + "Specify border color for non-terminal box." :type 'string :version "20" :group 'ebnf-non-terminal) (defcustom ebnf-arrow-shape 'hollow - "*Specify the arrow shape. + "Specify the arrow shape. Valid values are: @@ -1733,7 +1733,7 @@ Any other value is treated as `none'." (defcustom ebnf-chart-shape 'round - "*Specify chart flow shape. + "Specify chart flow shape. See documentation for `ebnf-non-terminal-shape'." :type '(radio :tag "Chart Flow Shape" @@ -1743,7 +1743,7 @@ See documentation for `ebnf-non-terminal-shape'." (defcustom ebnf-user-arrow nil - "*Specify a sexp for user arrow shape (a PostScript code). + "Specify a sexp for user arrow shape (a PostScript code). When evaluated, the sexp should return nil or a string containing PostScript code. PostScript code should draw a right arrow. @@ -1783,7 +1783,7 @@ symbol `user'." (defcustom ebnf-syntax 'ebnf - "*Specify syntax to be recognized. + "Specify syntax to be recognized. Valid values are: @@ -1827,7 +1827,7 @@ Any other value is treated as `ebnf'." (defcustom ebnf-lex-comment-char ?\; - "*Specify the line comment character. + "Specify the line comment character. It's used only when `ebnf-syntax' is `ebnf'." :type 'character @@ -1836,7 +1836,7 @@ It's used only when `ebnf-syntax' is `ebnf'." (defcustom ebnf-lex-eop-char ?. - "*Specify the end of production character. + "Specify the end of production character. It's used only when `ebnf-syntax' is `ebnf'." :type 'character @@ -1845,7 +1845,7 @@ It's used only when `ebnf-syntax' is `ebnf'." (defcustom ebnf-terminal-regexp nil - "*Specify how it's a terminal name. + "Specify how it's a terminal name. If it's nil, the terminal name must be enclosed by `\"'. If it's a string, it should be a regexp that it'll be used to determine a @@ -1859,7 +1859,7 @@ It's used only when `ebnf-syntax' is `ebnf'." (defcustom ebnf-case-fold-search nil - "*Non-nil means ignore case on matching. + "Non-nil means ignore case on matching. It's only used when `ebnf-terminal-regexp' is non-nil and when `ebnf-syntax' is `ebnf'." @@ -1869,7 +1869,7 @@ It's only used when `ebnf-terminal-regexp' is non-nil and when `ebnf-syntax' is (defcustom ebnf-iso-alternative-p nil - "*Non-nil means use alternative ISO EBNF. + "Non-nil means use alternative ISO EBNF. It's only used when `ebnf-syntax' is `iso-ebnf'. @@ -1888,7 +1888,7 @@ This variable affects the following symbol set: (defcustom ebnf-iso-normalize-p nil - "*Non-nil means normalize ISO EBNF syntax names. + "Non-nil means normalize ISO EBNF syntax names. Normalize a name means that several contiguous spaces inside name become a single space, so \"A B C\" is normalized to \"A B C\". @@ -1900,7 +1900,7 @@ It's only used when `ebnf-syntax' is `iso-ebnf'." (defcustom ebnf-file-suffix-regexp "\.[Bb][Nn][Ff]$" - "*Specify file name suffix that contains EBNF. + "Specify file name suffix that contains EBNF. See `ebnf-eps-directory' command." :type 'regexp @@ -1909,7 +1909,7 @@ See `ebnf-eps-directory' command." (defcustom ebnf-eps-prefix "ebnf--" - "*Specify EPS prefix file name. + "Specify EPS prefix file name. See `ebnf-eps-buffer' and `ebnf-eps-region' commands." :type 'string @@ -1918,7 +1918,7 @@ See `ebnf-eps-buffer' and `ebnf-eps-region' commands." (defcustom ebnf-eps-header-font '(11 Helvetica "Black" "White" bold) - "*Specify EPS header font. + "Specify EPS header font. See documentation for `ebnf-production-font'. @@ -1942,7 +1942,7 @@ See `ebnf-eps-buffer' and `ebnf-eps-region' commands." (defcustom ebnf-eps-header nil - "*Specify EPS header. + "Specify EPS header. The value should be a string, a symbol or nil. @@ -1978,7 +1978,7 @@ empty string, no header is generated until a non-empty header is specified or (defcustom ebnf-eps-footer-font '(7 Helvetica "Black" "White" bold) - "*Specify EPS footer font. + "Specify EPS footer font. See documentation for `ebnf-production-font'. @@ -2002,7 +2002,7 @@ See `ebnf-eps-buffer' and `ebnf-eps-region' commands." (defcustom ebnf-eps-footer nil - "*Specify EPS footer. + "Specify EPS footer. The value should be a string, a symbol or nil. @@ -2038,7 +2038,7 @@ empty string, no footer is generated until a non-empty footer is specified or (defcustom ebnf-entry-percentage 0.5 ; middle - "*Specify entry height on alternatives. + "Specify entry height on alternatives. It must be a float between 0.0 (top) and 1.0 (bottom)." :type 'number @@ -2047,7 +2047,7 @@ It must be a float between 0.0 (top) and 1.0 (bottom)." (defcustom ebnf-default-width 0.6 - "*Specify additional border width over default terminal, non-terminal or + "Specify additional border width over default terminal, non-terminal or special." :type 'number :version "20" @@ -2057,21 +2057,21 @@ special." ;; Printing color requires x-color-values. (defcustom ebnf-color-p (or (fboundp 'x-color-values) ; Emacs (fboundp 'color-instance-rgb-components)) ; XEmacs - "*Non-nil means use color." + "Non-nil means use color." :type 'boolean :version "20" :group 'ebnf2ps) (defcustom ebnf-line-width 1.0 - "*Specify flow line width." + "Specify flow line width." :type 'number :version "20" :group 'ebnf2ps) (defcustom ebnf-line-color "Black" - "*Specify flow line color." + "Specify flow line color." :type 'string :version "20" :group 'ebnf2ps) @@ -2081,7 +2081,7 @@ special." (if (eq ebnf-arrow-shape 'none) 0.0 (* (sqrt 5.0) 0.65 ebnf-line-width)) - "*Specify extra width for arrow shape drawing. + "Specify extra width for arrow shape drawing. The extra width is used to avoid that the arrowhead and the terminal border overlap. It depends on `ebnf-arrow-shape' and `ebnf-line-width'." @@ -2091,7 +2091,7 @@ overlap. It depends on `ebnf-arrow-shape' and `ebnf-line-width'." (defcustom ebnf-arrow-scale 1.0 - "*Specify the arrow scale. + "Specify the arrow scale. Values lower than 1.0, shrink the arrow. Values greater than 1.0, expand the arrow." @@ -2101,7 +2101,7 @@ Values greater than 1.0, expand the arrow." (defcustom ebnf-debug-ps nil - "*Non-nil means to generate PostScript debug procedures. + "Non-nil means to generate PostScript debug procedures. It is intended to help PostScript programmers in debugging." :type 'boolean @@ -2110,7 +2110,7 @@ It is intended to help PostScript programmers in debugging." (defcustom ebnf-use-float-format t - "*Non-nil means use `%f' float format. + "Non-nil means use `%f' float format. The advantage of using float format is that ebnf2ps generates a little short PostScript file. @@ -2126,14 +2126,14 @@ when executing ebnf2ps, set `ebnf-use-float-format' to nil." (defcustom ebnf-stop-on-error nil - "*Non-nil means signal error and stop. Otherwise, signal error and continue." + "Non-nil means signal error and stop. Otherwise, signal error and continue." :type 'boolean :version "20" :group 'ebnf2ps) (defcustom ebnf-yac-ignore-error-recovery nil - "*Non-nil means ignore error recovery. + "Non-nil means ignore error recovery. It's only used when `ebnf-syntax' is `yacc'." :type 'boolean @@ -2142,7 +2142,7 @@ It's only used when `ebnf-syntax' is `yacc'." (defcustom ebnf-ignore-empty-rule nil - "*Non-nil means ignore empty rules. + "Non-nil means ignore empty rules. It's interesting to set this variable if your Yacc/Bison grammar has a lot of middle action rule." @@ -2152,7 +2152,7 @@ middle action rule." (defcustom ebnf-optimize nil - "*Non-nil means optimize syntactic chart of rules. + "Non-nil means optimize syntactic chart of rules. The following optimizations are done: @@ -2179,7 +2179,7 @@ The above optimizations are specially useful when `ebnf-syntax' is `yacc'." (defcustom ebnf-log nil - "*Non-nil means generate log messages. + "Non-nil means generate log messages. The log messages are generated into the buffer *Ebnf2ps Log*. These messages are intended to help debugging ebnf2ps." diff --git a/lisp/progmodes/ebrowse.el b/lisp/progmodes/ebrowse.el index 4a07392c309..849ca4b7c9d 100644 --- a/lisp/progmodes/ebrowse.el +++ b/lisp/progmodes/ebrowse.el @@ -50,7 +50,7 @@ (defcustom ebrowse-search-path nil - "*List of directories to search for source files in a class tree. + "List of directories to search for source files in a class tree. Elements should be directory names; nil as an element means to try to find source files relative to the location of the BROWSE file loaded." :group 'ebrowse @@ -59,25 +59,25 @@ to find source files relative to the location of the BROWSE file loaded." (defcustom ebrowse-view/find-hook nil - "*Hooks run after finding or viewing a member or class." + "Hooks run after finding or viewing a member or class." :group 'ebrowse :type 'hook) (defcustom ebrowse-not-found-hook nil - "*Hooks run when finding or viewing a member or class was not successful." + "Hooks run when finding or viewing a member or class was not successful." :group 'ebrowse :type 'hook) (defcustom ebrowse-electric-list-mode-hook nil - "*Hook called by `ebrowse-electric-position-mode'." + "Hook called by `ebrowse-electric-position-mode'." :group 'ebrowse :type 'hook) (defcustom ebrowse-max-positions 50 - "*Number of markers saved on electric position stack." + "Number of markers saved on electric position stack." :group 'ebrowse :type 'integer) @@ -89,31 +89,31 @@ to find source files relative to the location of the BROWSE file loaded." (defcustom ebrowse-tree-mode-hook nil - "*Hook run in each new tree buffer." + "Hook run in each new tree buffer." :group 'ebrowse-tree :type 'hook) (defcustom ebrowse-tree-buffer-name "*Tree*" - "*The default name of class tree buffers." + "The default name of class tree buffers." :group 'ebrowse-tree :type 'string) (defcustom ebrowse--indentation 4 - "*The amount by which subclasses are indented in the tree." + "The amount by which subclasses are indented in the tree." :group 'ebrowse-tree :type 'integer) (defcustom ebrowse-source-file-column 40 - "*The column in which source file names are displayed in the tree." + "The column in which source file names are displayed in the tree." :group 'ebrowse-tree :type 'integer) (defcustom ebrowse-tree-left-margin 2 - "*Amount of space left at the left side of the tree display. + "Amount of space left at the left side of the tree display. This space is used to display markers." :group 'ebrowse-tree :type 'integer) @@ -126,25 +126,25 @@ This space is used to display markers." (defcustom ebrowse-default-declaration-column 25 - "*The column in which member declarations are displayed in member buffers." + "The column in which member declarations are displayed in member buffers." :group 'ebrowse-member :type 'integer) (defcustom ebrowse-default-column-width 25 - "*The width of the columns in member buffers (short display form)." + "The width of the columns in member buffers (short display form)." :group 'ebrowse-member :type 'integer) (defcustom ebrowse-member-buffer-name "*Members*" - "*The name of the buffer for member display." + "The name of the buffer for member display." :group 'ebrowse-member :type 'string) (defcustom ebrowse-member-mode-hook nil - "*Run in each new member buffer." + "Run in each new member buffer." :group 'ebrowse-member :type 'hook) @@ -158,7 +158,7 @@ This space is used to display markers." (defface ebrowse-tree-mark '((((min-colors 88)) (:foreground "red1")) (t (:foreground "red"))) - "*The face used for the mark character in the tree." + "The face used for the mark character in the tree." :group 'ebrowse-faces) (define-obsolete-face-alias 'ebrowse-tree-mark-face 'ebrowse-tree-mark "22.1") @@ -166,21 +166,21 @@ This space is used to display markers." (defface ebrowse-root-class '((((min-colors 88)) (:weight bold :foreground "blue1")) (t (:weight bold :foreground "blue"))) - "*The face used for root classes in the tree." + "The face used for root classes in the tree." :group 'ebrowse-faces) (define-obsolete-face-alias 'ebrowse-root-class-face 'ebrowse-root-class "22.1") (defface ebrowse-file-name '((t (:italic t))) - "*The face for filenames displayed in the tree." + "The face for filenames displayed in the tree." :group 'ebrowse-faces) (define-obsolete-face-alias 'ebrowse-file-name-face 'ebrowse-file-name "22.1") (defface ebrowse-default '((t nil)) - "*Face for everything else in the tree not having other faces." + "Face for everything else in the tree not having other faces." :group 'ebrowse-faces) (define-obsolete-face-alias 'ebrowse-default-face 'ebrowse-default "22.1") @@ -188,7 +188,7 @@ This space is used to display markers." (defface ebrowse-member-attribute '((((min-colors 88)) (:foreground "red1")) (t (:foreground "red"))) - "*Face used to display member attributes." + "Face used to display member attributes." :group 'ebrowse-faces) (define-obsolete-face-alias 'ebrowse-member-attribute-face 'ebrowse-member-attribute "22.1") @@ -196,7 +196,7 @@ This space is used to display markers." (defface ebrowse-member-class '((t (:foreground "purple"))) - "*Face used to display the class title in member buffers." + "Face used to display the class title in member buffers." :group 'ebrowse-faces) (define-obsolete-face-alias 'ebrowse-member-class-face 'ebrowse-member-class "22.1") @@ -205,7 +205,7 @@ This space is used to display markers." (defface ebrowse-progress '((((min-colors 88)) (:background "blue1")) (t (:background "blue"))) - "*Face for progress indicator." + "Face for progress indicator." :group 'ebrowse-faces) (define-obsolete-face-alias 'ebrowse-progress-face 'ebrowse-progress "22.1") @@ -4178,7 +4178,7 @@ NUMBER-OF-STATIC-VARIABLES:" ;; prefix `\C-c\C-m' to browse commands. (defvar ebrowse-global-map nil - "*Keymap for Ebrowse commands.") + "Keymap for Ebrowse commands.") (defvar ebrowse-global-prefix-key "\C-c\C-m" diff --git a/lisp/progmodes/etags.el b/lisp/progmodes/etags.el index 6bb86738df0..d8a561340d3 100644 --- a/lisp/progmodes/etags.el +++ b/lisp/progmodes/etags.el @@ -33,7 +33,7 @@ ;;;###autoload (defvar tags-file-name nil - "*File name of tags table. + "File name of tags table. To switch to a new tags table, setting this variable is sufficient. If you set this variable, do not also set `tags-table-list'. Use the `etags' program to make a tags table file.") @@ -46,7 +46,7 @@ Use the `etags' program to make a tags table file.") ;;;###autoload (defcustom tags-case-fold-search 'default - "*Whether tags operations should be case-sensitive. + "Whether tags operations should be case-sensitive. A value of t means case-insensitive, a value of nil means case-sensitive. Any other value means use the setting of `case-fold-search'." :group 'etags @@ -58,7 +58,7 @@ Any other value means use the setting of `case-fold-search'." ;;;###autoload ;; Use `visit-tags-table-buffer' to cycle through tags tables in this list. (defcustom tags-table-list nil - "*List of file names of tags tables to search. + "List of file names of tags tables to search. An element that is a directory means the file \"TAGS\" in that directory. To switch to a new list of tags tables, setting this variable is sufficient. If you set this variable, do not also set `tags-file-name'. @@ -69,7 +69,7 @@ Use the `etags' program to make a tags table file." ;;;###autoload (defcustom tags-compression-info-list (purecopy '("" ".Z" ".bz2" ".gz" ".xz" ".tgz")) - "*List of extensions tried by etags when jka-compr is used. + "List of extensions tried by etags when jka-compr is used. An empty string means search the non-compressed file. These extensions will be tried only if jka-compr was activated \(i.e. via customize of `auto-compression-mode' or by calling the function @@ -90,7 +90,7 @@ These extensions will be tried only if jka-compr was activated ;;;###autoload (defcustom tags-add-tables 'ask-user - "*Control whether to add a new tags table to the current list. + "Control whether to add a new tags table to the current list. t means do; nil means don't (always start a new list). Any other value means ask the user whether to add a new tags table to the current list (as opposed to starting a new list)." @@ -100,7 +100,7 @@ to the current list (as opposed to starting a new list)." (other :tag "Ask" ask-user))) (defcustom tags-revert-without-query nil - "*Non-nil means reread a TAGS table without querying, if it has changed." + "Non-nil means reread a TAGS table without querying, if it has changed." :group 'etags :type 'boolean) @@ -131,7 +131,7 @@ Each element is a list of strings which are file names.") ;;;###autoload (defcustom find-tag-hook nil - "*Hook to be run by \\[find-tag] after finding a tag. See `run-hooks'. + "Hook to be run by \\[find-tag] after finding a tag. See `run-hooks'. The value in the buffer in which \\[find-tag] is done is used, not the value in the buffer \\[find-tag] goes to." :group 'etags @@ -139,7 +139,7 @@ not the value in the buffer \\[find-tag] goes to." ;;;###autoload (defcustom find-tag-default-function nil - "*A function of no arguments used by \\[find-tag] to pick a default tag. + "A function of no arguments used by \\[find-tag] to pick a default tag. If nil, and the symbol that is the value of `major-mode' has a `find-tag-default-function' property (see `put'), that is used. Otherwise, `find-tag-default' is used." @@ -147,13 +147,13 @@ Otherwise, `find-tag-default' is used." :type '(choice (const nil) function)) (defcustom find-tag-marker-ring-length 16 - "*Length of marker rings `find-tag-marker-ring' and `tags-location-ring'." + "Length of marker rings `find-tag-marker-ring' and `tags-location-ring'." :group 'etags :type 'integer :version "20.3") (defcustom tags-tag-face 'default - "*Face for tags in the output of `tags-apropos'." + "Face for tags in the output of `tags-apropos'." :group 'etags :type 'face :version "21.1") @@ -1687,7 +1687,7 @@ Point should be just after a string that matches TAG." (re-search-backward re bol t))))) (defcustom tags-loop-revert-buffers nil - "*Non-nil means tags-scanning loops should offer to reread changed files. + "Non-nil means tags-scanning loops should offer to reread changed files. These loops normally read each file into Emacs, but when a file is already visited, they use the existing buffer. When this flag is non-nil, they offer to revert the existing buffer diff --git a/lisp/progmodes/executable.el b/lisp/progmodes/executable.el index c44f1d73501..e5142571972 100644 --- a/lisp/progmodes/executable.el +++ b/lisp/progmodes/executable.el @@ -57,7 +57,7 @@ ;; This used to default to `other', but that doesn't seem to have any ;; significance. fx 2000-02-11. (defcustom executable-insert t ; 'other - "*Non-nil means offer to add a magic number to a file. + "Non-nil means offer to add a magic number to a file. This takes effect when you switch to certain major modes, including Shell-script mode (`sh-mode'). When you type \\[executable-set-magic], it always offers to add or @@ -70,7 +70,7 @@ update the magic number." (defcustom executable-query 'function - "*If non-nil, ask user before changing an existing magic number. + "If non-nil, ask user before changing an existing magic number. When this is `function', only ask when called non-interactively." :type '(choice (const :tag "Don't Ask" nil) (const :tag "Ask when non-interactive" function) @@ -79,19 +79,19 @@ When this is `function', only ask when called non-interactively." (defcustom executable-magicless-file-regexp "/[Mm]akefile$\\|/\\.\\(z?profile\\|bash_profile\\|z?login\\|bash_login\\|z?logout\\|bash_logout\\|.+shrc\\|esrc\\|rcrc\\|[kz]shenv\\)$" - "*On files with this kind of name no magic is inserted or changed." + "On files with this kind of name no magic is inserted or changed." :type 'regexp :group 'executable) (defcustom executable-prefix "#! " - "*Interpreter magic number prefix inserted when there was no magic number." + "Interpreter magic number prefix inserted when there was no magic number." :type 'string :group 'executable) (defcustom executable-chmod 73 - "*After saving, if the file is not executable, set this mode. + "After saving, if the file is not executable, set this mode. This mode passed to `set-file-modes' is taken absolutely when negative, or relative to the files existing modes. Do nothing if this is nil. Typical values are 73 (+x) or -493 (rwxr-xr-x)." @@ -103,7 +103,7 @@ Typical values are 73 (+x) or -493 (rwxr-xr-x)." (defvar executable-command nil) (defcustom executable-self-display "tail" - "*Command you use with argument `+2' to make text files self-display. + "Command you use with argument `+2' to make text files self-display. Note that the like of `more' doesn't work too well under Emacs \\[shell]." :type 'string :group 'executable) @@ -111,7 +111,7 @@ Note that the like of `more' doesn't work too well under Emacs \\[shell]." (defvar executable-font-lock-keywords '(("\\`#!.*/\\([^ \t\n]+\\)" 1 font-lock-keyword-face t)) - "*Rules for highlighting executable scripts' magic number. + "Rules for highlighting executable scripts' magic number. This can be included in `font-lock-keywords' by modes that call `executable'.") diff --git a/lisp/progmodes/f90.el b/lisp/progmodes/f90.el index df6fdfd7cd9..1d2beedd191 100644 --- a/lisp/progmodes/f90.el +++ b/lisp/progmodes/f90.el @@ -651,7 +651,7 @@ logical\\|double[ \t]*precision\\|type[ \t]*(\\sw+)\\|none\\)[ \t]*" (defvar f90-font-lock-keywords f90-font-lock-keywords-2 - "*Default expressions to highlight in F90 mode. + "Default expressions to highlight in F90 mode. Can be overridden by the value of `font-lock-maximum-decoration'.") diff --git a/lisp/progmodes/glasses.el b/lisp/progmodes/glasses.el index b49739a94d5..7c131dd316c 100644 --- a/lisp/progmodes/glasses.el +++ b/lisp/progmodes/glasses.el @@ -78,7 +78,7 @@ string." (defcustom glasses-original-separator "_" - "*String to be displayed as `glasses-separator' in separator positions. + "String to be displayed as `glasses-separator' in separator positions. For instance, if you set it to \"_\" and set `glasses-separator' to \"-\", underscore separators are displayed as hyphens. If `glasses-original-separator' is an empty string, no such display change is diff --git a/lisp/progmodes/grep.el b/lisp/progmodes/grep.el index 54d678323f6..d41364547f2 100644 --- a/lisp/progmodes/grep.el +++ b/lisp/progmodes/grep.el @@ -61,7 +61,7 @@ SYMBOL should be one of `grep-command', `grep-template', ;;;###autoload (defcustom grep-window-height nil - "*Number of lines in a grep window. If nil, use `compilation-window-height'." + "Number of lines in a grep window. If nil, use `compilation-window-height'." :type '(choice (const :tag "Default" nil) integer) :version "22.1" @@ -104,7 +104,7 @@ To change the default value, use Customize or call the function :group 'grep) (defcustom grep-scroll-output nil - "*Non-nil to scroll the *grep* buffer window as output appears. + "Non-nil to scroll the *grep* buffer window as output appears. Setting it causes the grep commands to put point at the end of their output window so that the end of the output is always visible rather @@ -203,13 +203,13 @@ Customize or call the function `grep-apply-setting'." ("tex" . "*.tex") ("texi" . "*.texi") ("asm" . "*.[sS]")) - "*Alist of aliases for the FILES argument to `lgrep' and `rgrep'." + "Alist of aliases for the FILES argument to `lgrep' and `rgrep'." :type 'alist :group 'grep) (defcustom grep-find-ignored-directories vc-directory-exclusion-list - "*List of names of sub-directories which `rgrep' shall not recurse into. + "List of names of sub-directories which `rgrep' shall not recurse into. If an element is a cons cell, the car is called on the search directory to determine whether cdr should not be recursed into." :type '(choice (repeat :tag "Ignored directories" string) @@ -221,7 +221,7 @@ to determine whether cdr should not be recursed into." (unless (string-match-p "/\\'" s) (concat "*" s))) completion-ignored-extensions))) - "*List of file names which `rgrep' and `lgrep' shall exclude. + "List of file names which `rgrep' and `lgrep' shall exclude. If an element is a cons cell, the car is called on the search directory to determine whether cdr should not be excluded." :type '(choice (repeat :tag "Ignored file" string) @@ -229,7 +229,7 @@ to determine whether cdr should not be excluded." :group 'grep) (defcustom grep-error-screen-columns nil - "*If non-nil, column numbers in grep hits are screen columns. + "If non-nil, column numbers in grep hits are screen columns. See `compilation-error-screen-columns'" :type '(choice (const :tag "Default" nil) integer) diff --git a/lisp/progmodes/gud.el b/lisp/progmodes/gud.el index 121a023cd54..6b1f891b230 100644 --- a/lisp/progmodes/gud.el +++ b/lisp/progmodes/gud.el @@ -1046,7 +1046,7 @@ and source-file directory for your debugger." (defvar gud-dbx-history nil) (defcustom gud-dbx-directories nil - "*A list of directories that dbx should search for source code. + "A list of directories that dbx should search for source code. If nil, only source files in the program directory will be known to dbx. @@ -1358,7 +1358,7 @@ and source-file directory for your debugger." (defvar gud-xdb-history nil) (defcustom gud-xdb-directories nil - "*A list of directories that xdb should search for source code. + "A list of directories that xdb should search for source code. If nil, only source files in the program directory will be known to xdb. @@ -1811,7 +1811,7 @@ source file information.") ;; List of Java source file directories. (defvar gud-jdb-directories (list ".") - "*A list of directories that gud jdb should search for source code. + "A list of directories that gud jdb should search for source code. The file names should be absolute, or relative to the current directory. diff --git a/lisp/progmodes/hideshow.el b/lisp/progmodes/hideshow.el index 26db60ddbc2..e2016e206a8 100644 --- a/lisp/progmodes/hideshow.el +++ b/lisp/progmodes/hideshow.el @@ -238,18 +238,18 @@ :group 'languages) (defcustom hs-hide-comments-when-hiding-all t - "*Hide the comments too when you do an `hs-hide-all'." + "Hide the comments too when you do an `hs-hide-all'." :type 'boolean :group 'hideshow) (defcustom hs-minor-mode-hook nil - "*Hook called when hideshow minor mode is activated or deactivated." + "Hook called when hideshow minor mode is activated or deactivated." :type 'hook :group 'hideshow :version "21.1") (defcustom hs-isearch-open 'code - "*What kind of hidden blocks to open when doing `isearch'. + "What kind of hidden blocks to open when doing `isearch'. One of the following symbols: code -- open only code blocks @@ -272,7 +272,7 @@ This has effect only if `search-invisible' is set to `open'." (bibtex-mode ("@\\S(*\\(\\s(\\)" 1)) (java-mode "{" "}" "/[*/]" nil nil) (js-mode "{" "}" "/[*/]" nil))) - "*Alist for initializing the hideshow variables for different modes. + "Alist for initializing the hideshow variables for different modes. Each element has the form (MODE START END COMMENT-START FORWARD-SEXP-FUNC ADJUST-BEG-FUNC). @@ -300,25 +300,25 @@ appropriate values. The regexps should not contain leading or trailing whitespace. Case does not matter.") (defvar hs-hide-all-non-comment-function nil - "*Function called if non-nil when doing `hs-hide-all' for non-comments.") + "Function called if non-nil when doing `hs-hide-all' for non-comments.") (defvar hs-allow-nesting nil - "*If non-nil, hiding remembers internal blocks. + "If non-nil, hiding remembers internal blocks. This means that when the outer block is shown again, any previously hidden internal blocks remain hidden.") (defvar hs-hide-hook nil - "*Hook called (with `run-hooks') at the end of commands to hide text. + "Hook called (with `run-hooks') at the end of commands to hide text. These commands include the toggling commands (when the result is to hide a block), `hs-hide-all', `hs-hide-block' and `hs-hide-level'.") (defvar hs-show-hook nil - "*Hook called (with `run-hooks') at the end of commands to show text. + "Hook called (with `run-hooks') at the end of commands to show text. These commands include the toggling commands (when the result is to show a block), `hs-show-all' and `hs-show-block'.") (defvar hs-set-up-overlay nil - "*Function called with one arg, OV, a newly initialized overlay. + "Function called with one arg, OV, a newly initialized overlay. Hideshow puts a unique overlay on each range of text to be hidden in the buffer. Here is a simple example of how to use this variable: diff --git a/lisp/progmodes/icon.el b/lisp/progmodes/icon.el index 35c29e10627..205b226160a 100644 --- a/lisp/progmodes/icon.el +++ b/lisp/progmodes/icon.el @@ -85,39 +85,39 @@ :group 'languages) (defcustom icon-indent-level 4 - "*Indentation of Icon statements with respect to containing block." + "Indentation of Icon statements with respect to containing block." :type 'integer :group 'icon) (defcustom icon-brace-imaginary-offset 0 - "*Imagined indentation of a Icon open brace that actually follows a statement." + "Imagined indentation of a Icon open brace that actually follows a statement." :type 'integer :group 'icon) (defcustom icon-brace-offset 0 - "*Extra indentation for braces, compared with other text in same context." + "Extra indentation for braces, compared with other text in same context." :type 'integer :group 'icon) (defcustom icon-continued-statement-offset 4 - "*Extra indent for Icon lines not starting new statements." + "Extra indent for Icon lines not starting new statements." :type 'integer :group 'icon) (defcustom icon-continued-brace-offset 0 - "*Extra indent for Icon substatements that start with open-braces. + "Extra indent for Icon substatements that start with open-braces. This is in addition to `icon-continued-statement-offset'." :type 'integer :group 'icon) (defcustom icon-auto-newline nil - "*Non-nil means automatically newline before and after braces Icon code. + "Non-nil means automatically newline before and after braces Icon code. This applies when braces are inserted." :type 'boolean :group 'icon) (defcustom icon-tab-always-indent t - "*Non-nil means TAB in Icon mode should always reindent the current line. + "Non-nil means TAB in Icon mode should always reindent the current line. It will then reindent, regardless of where in the line point is when the TAB command is used." :type 'boolean diff --git a/lisp/progmodes/idlw-help.el b/lisp/progmodes/idlw-help.el index f2f9fd30ed4..0cb8b7da4aa 100644 --- a/lisp/progmodes/idlw-help.el +++ b/lisp/progmodes/idlw-help.el @@ -115,7 +115,7 @@ must be explicitly set non-nil in order for the variable "Obsolete variable. See `idlwave-html-help-location'.") (defcustom idlwave-help-use-dedicated-frame t - "*Non-nil means, use a separate frame for Online Help if possible." + "Non-nil means, use a separate frame for Online Help if possible." :group 'idlwave-online-help :type 'boolean) @@ -164,12 +164,12 @@ probably a good idea to still call this function as a fallback." :type 'symbol) (defcustom idlwave-help-fontify-source-code nil - "*Non-nil means, fontify source code displayed as help like normal code." + "Non-nil means, fontify source code displayed as help like normal code." :group 'idlwave-online-help :type 'boolean) (defcustom idlwave-help-source-try-header t - "*Non-nil means, try to find help in routine header when displaying source. + "Non-nil means, try to find help in routine header when displaying source. Routines which are not documented in the system manual use their source as help text. When this variable is non-nil, we try to find a description of the help item in the first routine doclib header above the routine definition. @@ -180,14 +180,14 @@ definition is displayed instead." (defcustom idlwave-help-doclib-name "name" - "*A regexp for the heading word to search for in doclib headers + "A regexp for the heading word to search for in doclib headers which specifies the `name' section. Can be used for localization support." :group 'idlwave-online-help :type 'string) (defcustom idlwave-help-doclib-keyword "KEYWORD" - "*A regexp for the heading word to search for in doclib headers + "A regexp for the heading word to search for in doclib headers which specifies the `keywords' section. Can be used for localization support." :group 'idlwave-online-help diff --git a/lisp/progmodes/idlw-shell.el b/lisp/progmodes/idlw-shell.el index 55a085fbde0..d843de04913 100644 --- a/lisp/progmodes/idlw-shell.el +++ b/lisp/progmodes/idlw-shell.el @@ -106,7 +106,7 @@ :group 'idlwave) (defcustom idlwave-shell-prompt-pattern "^\r? ?IDL> " - "*Regexp to match IDL prompt at beginning of a line. + "Regexp to match IDL prompt at beginning of a line. For example, \"^\r?IDL> \" or \"^\r?WAVE> \". The \"^\r?\" is needed, to indicate the beginning of the line, with optional return character (which IDL seems to output randomly). @@ -118,7 +118,7 @@ This is a fine thing to set in your `.emacs' file." :type 'regexp) (defcustom idlwave-shell-process-name "idl" - "*Name to be associated with the IDL process. The buffer for the + "Name to be associated with the IDL process. The buffer for the process output is made by surrounding this name with `*'s." :group 'idlwave-shell-general-setup :type 'string) @@ -126,12 +126,12 @@ process output is made by surrounding this name with `*'s." ;; (defcustom idlwave-shell-automatic-start...) See idlwave.el (defcustom idlwave-shell-use-dedicated-window nil - "*Non-nil means, never replace the shell frame with another buffer." + "Non-nil means, never replace the shell frame with another buffer." :group 'idlwave-shell-general-setup :type 'boolean) (defcustom idlwave-shell-use-dedicated-frame nil - "*Non-nil means, IDLWAVE should use a special frame to display shell buffer." + "Non-nil means, IDLWAVE should use a special frame to display shell buffer." :group 'idlwave-shell-general-setup :type 'boolean) @@ -145,12 +145,12 @@ The default makes the frame splittable, so that completion works correctly." (cons symbol sexp))) (defcustom idlwave-shell-raise-frame t - "*Non-nil means, `idlwave-shell' raises the frame showing the shell window." + "Non-nil means, `idlwave-shell' raises the frame showing the shell window." :group 'idlwave-shell-general-setup :type 'boolean) (defcustom idlwave-shell-arrows-do-history t - "*Non-nil means UP and DOWN arrows move through command history. + "Non-nil means UP and DOWN arrows move through command history. This variable can have 3 values: nil Arrows just move the cursor t Arrows force the cursor back to the current command line and @@ -166,7 +166,7 @@ t Arrows force the cursor back to the current command line and ;; FIXME: add comint-input-ring-size? (defcustom idlwave-shell-use-toolbar t - "*Non-nil means, use the debugging toolbar in all IDL related buffers. + "Non-nil means, use the debugging toolbar in all IDL related buffers. Starting the shell will then add the toolbar to all idlwave-mode buffers. Exiting the shell will removed everywhere. Available on XEmacs and on Emacs 21.x or later. @@ -176,7 +176,7 @@ At any time you can toggle the display of the toolbar with :type 'boolean) (defcustom idlwave-shell-temp-pro-prefix "/tmp/idltemp" - "*The prefix for temporary IDL files used when compiling regions. + "The prefix for temporary IDL files used when compiling regions. It should be an absolute pathname. The full temporary file name is obtained by using `make-temp-file' so that the name will be unique among multiple Emacs processes." @@ -184,13 +184,13 @@ so that the name will be unique among multiple Emacs processes." :type 'string) (defvar idlwave-shell-fix-inserted-breaks nil - "*OBSOLETE VARIABLE, is no longer used. + "OBSOLETE VARIABLE, is no longer used. The documentation of this variable used to be: If non-nil then run `idlwave-shell-remove-breaks' to clean up IDL messages.") (defcustom idlwave-shell-prefix-key "\C-c\C-d" - "*The prefix key for the debugging map `idlwave-shell-mode-prefix-map'. + "The prefix key for the debugging map `idlwave-shell-mode-prefix-map'. This variable must already be set when idlwave-shell.el is loaded. Setting it in the mode-hook is too late." :group 'idlwave-shell-general-setup @@ -227,7 +227,7 @@ window, but is useful for stepping, etc." "Obsolete variable. See `idlwave-shell-debug-modifiers'.") (defcustom idlwave-shell-use-truename nil - "*Non-nil means, use `file-truename' when looking for buffers. + "Non-nil means, use `file-truename' when looking for buffers. If this variable is non-nil, Emacs will use the function `file-truename' to resolve symbolic links in the file paths printed by e.g., STOP commands. This means, unvisited files will be loaded under their truename. @@ -247,7 +247,7 @@ because these are used as separators by IDL." :type 'string) (defcustom idlwave-shell-mode-hook '() - "*Hook for customizing `idlwave-shell-mode'." + "Hook for customizing `idlwave-shell-mode'." :group 'idlwave-shell-general-setup :type 'hook) @@ -292,7 +292,7 @@ is non-nil." (defcustom idlwave-shell-show-commands '(run misc breakpoint) - "*A list of command types to show output from in the shell. + "A list of command types to show output from in the shell. Possibilities are 'run, 'debug, 'breakpoint, and 'misc. Unselected types are not displayed in the shell. The type 'everything causes all the copious shell traffic to be displayed." @@ -336,10 +336,10 @@ expression being examined." (string :tag "Command")))) (defvar idlwave-shell-print-expression-function nil - "*OBSOLETE VARIABLE, is no longer used.") + "OBSOLETE VARIABLE, is no longer used.") (defcustom idlwave-shell-separate-examine-output t - "*Non-nil means, put output of examine commands in their own buffer." + "Non-nil means, put output of examine commands in their own buffer." :group 'idlwave-shell-command-setup :type 'boolean) @@ -359,12 +359,12 @@ newly created." (cons variable sexp))) (defcustom idlwave-shell-query-for-class t - "*Non-nil means query the shell for object class on object completions." + "Non-nil means query the shell for object class on object completions." :group 'idlwave-shell-command-setup :type 'boolean) (defcustom idlwave-shell-use-input-mode-magic nil - "*Non-nil means, IDLWAVE should check for input mode spells in output. + "Non-nil means, IDLWAVE should check for input mode spells in output. The spells are strings printed by your IDL program and matched by the regular expressions in `idlwave-shell-input-mode-spells'. When these expressions match, IDLWAVE switches to character input mode and @@ -432,7 +432,7 @@ end" (regexp :tag "Line-mode regexp"))) (defcustom idlwave-shell-breakpoint-popup-menu t - "*If non-nil, provide a menu on mouse-3 on breakpoint lines, and + "If non-nil, provide a menu on mouse-3 on breakpoint lines, and popup help text on the line." :group 'idlwave-shell-command-setup :type 'boolean) @@ -449,7 +449,7 @@ popup help text on the line." :group 'idlwave) (defcustom idlwave-shell-mark-stop-line t - "*Non-nil means, mark the source code line where IDL is currently stopped. + "Non-nil means, mark the source code line where IDL is currently stopped. Value decides about the method which is used to mark the line. Valid values are: @@ -471,7 +471,7 @@ hides any code, so setting this to 'arrow on Emacs 21 sounds like a good idea." (const :tag "Face or arrow." t))) (defcustom idlwave-shell-overlay-arrow ">" - "*The overlay arrow to display at source lines where execution halts. + "The overlay arrow to display at source lines where execution halts. We use a single character by default, since the main block of IDL procedures often has no indentation. Where possible, IDLWAVE will use overlays to display the stop-lines. The arrow is only used on character-based terminals. @@ -480,14 +480,14 @@ See also `idlwave-shell-use-overlay-arrow'." :type 'string) (defcustom idlwave-shell-stop-line-face 'highlight - "*The face for `idlwave-shell-stop-line-overlay'. + "The face for `idlwave-shell-stop-line-overlay'. Allows you to choose the font, color and other properties for line where IDL is stopped. See also `idlwave-shell-mark-stop-line'." :group 'idlwave-shell-highlighting-and-faces :type 'symbol) (defcustom idlwave-shell-electric-stop-color "Violet" - "*The color for the default face or overlay arrow when stopped." + "The color for the default face or overlay arrow when stopped." :group 'idlwave-shell-highlighting-and-faces :type 'string) @@ -499,14 +499,14 @@ line where IDL is stopped. See also `idlwave-shell-mark-stop-line'." (condition-case nil (set-face-foreground 'idlwave-shell-electric-stop-line nil) (error nil))) - "*The face for `idlwave-shell-stop-line-overlay' when in electric debug mode. + "The face for `idlwave-shell-stop-line-overlay' when in electric debug mode. Allows you to choose the font, color and other properties for the line where IDL is stopped, when in Electric Debug Mode." :group 'idlwave-shell-highlighting-and-faces :type 'symbol) (defcustom idlwave-shell-mark-breakpoints t - "*Non-nil means, mark breakpoints in the source files. + "Non-nil means, mark breakpoints in the source files. Valid values are: nil Do not mark breakpoints. 'face Highlight line with `idlwave-shell-breakpoint-face'. @@ -524,7 +524,7 @@ t Glyph when possible, otherwise face (same effect as 'glyph)." "Obsolete variable. See `idlwave-shell-mark-breakpoints'.") (defcustom idlwave-shell-breakpoint-face 'idlwave-shell-bp - "*The face for breakpoint lines in the source code. + "The face for breakpoint lines in the source code. Allows you to choose the font, color and other properties for lines which have a breakpoint. See also `idlwave-shell-mark-breakpoints'." :group 'idlwave-shell-highlighting-and-faces @@ -542,7 +542,7 @@ lines which have a breakpoint. See also `idlwave-shell-mark-breakpoints'." (defcustom idlwave-shell-disabled-breakpoint-face 'idlwave-shell-disabled-bp - "*The face for disabled breakpoint lines in the source code. + "The face for disabled breakpoint lines in the source code. Allows you to choose the font, color and other properties for lines which have a breakpoint. See also `idlwave-shell-mark-breakpoints'." :group 'idlwave-shell-highlighting-and-faces @@ -560,14 +560,14 @@ lines which have a breakpoint. See also `idlwave-shell-mark-breakpoints'." (defcustom idlwave-shell-expression-face 'secondary-selection - "*The face for `idlwave-shell-expression-overlay'. + "The face for `idlwave-shell-expression-overlay'. Allows you to choose the font, color and other properties for the expression printed by IDL." :group 'idlwave-shell-highlighting-and-faces :type 'symbol) (defcustom idlwave-shell-output-face 'secondary-selection - "*The face for `idlwave-shell-output-overlay'. + "The face for `idlwave-shell-output-overlay'. Allows you to choose the font, color and other properties for the expression output by IDL." :group 'idlwave-shell-highlighting-and-faces @@ -784,7 +784,7 @@ with `*'s." "^% Skipped to:" "^% Stop encountered:" ) - "*A list of regular expressions matching IDL messages. + "A list of regular expressions matching IDL messages. These are the messages containing file and line information where IDL is currently stopped.") @@ -795,19 +795,19 @@ IDL is currently stopped.") (defconst idlwave-shell-trace-message-re "^% At " ;; First line of a trace message - "*A regular expression matching IDL trace messages. These are the + "A regular expression matching IDL trace messages. These are the messages containing file and line information of a current traceback.") (defconst idlwave-shell-step-messages '("^% Stepped to:" ) - "*A list of regular expressions matching stepped execution messages. + "A list of regular expressions matching stepped execution messages. These are IDL messages containing file and line information where IDL has currently stepped.") (defvar idlwave-shell-break-message "^% Breakpoint at:" - "*Regular expression matching an IDL breakpoint message line.") + "Regular expression matching an IDL breakpoint message line.") (defconst idlwave-shell-electric-debug-help " ==> IDLWAVE Electric Debug Mode Help <== @@ -1672,7 +1672,7 @@ number.") "\\([ \t]*\n[ \t]*[^ \t\n]+\\)*" ; continuation lines file name (6) "\\)" ; end line number group (5) ) - "*A regular expression to parse out the file name and line number. + "A regular expression to parse out the file name and line number. The 1st group should match the subroutine name. The 3rd group is the line number. The 5th group is the file name. diff --git a/lisp/progmodes/idlwave.el b/lisp/progmodes/idlwave.el index 31fe20698b9..74f37df9b2d 100644 --- a/lisp/progmodes/idlwave.el +++ b/lisp/progmodes/idlwave.el @@ -195,34 +195,34 @@ :group 'idlwave) (defcustom idlwave-main-block-indent 2 - "*Extra indentation for the main block of code. + "Extra indentation for the main block of code. That is the block between the FUNCTION/PRO statement and the END statement for that program unit." :group 'idlwave-code-formatting :type 'integer) (defcustom idlwave-block-indent 3 - "*Extra indentation applied to block lines. + "Extra indentation applied to block lines. If you change this, you probably also want to change `idlwave-end-offset'." :group 'idlwave-code-formatting :type 'integer) (defcustom idlwave-end-offset -3 - "*Extra indentation applied to block END lines. + "Extra indentation applied to block END lines. A value equal to negative `idlwave-block-indent' will make END lines line up with the block BEGIN lines." :group 'idlwave-code-formatting :type 'integer) (defcustom idlwave-continuation-indent 3 - "*Extra indentation applied to continuation lines. + "Extra indentation applied to continuation lines. This extra offset applies to the first of a set of continuation lines. The following lines receive the same indentation as the first." :group 'idlwave-code-formatting :type 'integer) (defcustom idlwave-max-extra-continuation-indent 40 - "*Maximum additional indentation for special continuation indent. + "Maximum additional indentation for special continuation indent. Several special indentations are tried to help line up continuation lines in routine calls or definitions, other statements with parentheses, or assignment statements. This variable specifies a @@ -236,7 +236,7 @@ this variable." :type 'integer) (defcustom idlwave-indent-to-open-paren t - "*Non-nil means, indent continuation lines to innermost open parenthesis. + "Non-nil means, indent continuation lines to innermost open parenthesis. This indentation occurs even if otherwise disallowed by `idlwave-max-extra-continuation-indent'. Matching parens and the interleaving args are lined up. Example: @@ -260,38 +260,38 @@ would yield: :type 'boolean) (defcustom idlwave-indent-parens-nested nil - "*Non-nil means, indent continuation lines with parens by nesting + "Non-nil means, indent continuation lines with parens by nesting lines at consecutively deeper levels." :group 'idlwave-code-formatting :type 'boolean) (defcustom idlwave-hanging-indent t - "*If set non-nil then comment paragraphs are indented under the + "If set non-nil then comment paragraphs are indented under the hanging indent given by `idlwave-hang-indent-regexp' match in the first line of the paragraph." :group 'idlwave-code-formatting :type 'boolean) (defcustom idlwave-hang-indent-regexp "- " - "*Regular expression matching the position of the hanging indent + "Regular expression matching the position of the hanging indent in the first line of a comment paragraph. The size of the indent extends to the end of the match for the regular expression." :group 'idlwave-code-formatting :type 'regexp) (defcustom idlwave-use-last-hang-indent nil - "*If non-nil then use last match on line for `idlwave-indent-regexp'." + "If non-nil then use last match on line for `idlwave-indent-regexp'." :group 'idlwave-code-formatting :type 'boolean) (defcustom idlwave-fill-comment-line-only t - "*If non-nil then auto fill will only operate on comment lines." + "If non-nil then auto fill will only operate on comment lines." :group 'idlwave-code-formatting :type 'boolean) (defcustom idlwave-auto-fill-split-string t - "*If non-nil then auto fill will split strings with the IDL `+' operator. + "If non-nil then auto fill will split strings with the IDL `+' operator. When the line end falls within a string, string concatenation with the '+' operator will be used to distribute a long string over lines. If nil and a string is split then a terminal beep and warning are issued. @@ -302,7 +302,7 @@ non-nil, since in this case code is not auto-filled." :type 'boolean) (defcustom idlwave-split-line-string t - "*If non-nil then `idlwave-split-line' will split strings with `+'. + "If non-nil then `idlwave-split-line' will split strings with `+'. When the splitting point of a line falls inside a string, split the string using the `+' string concatenation operator. If nil and a string is split then a terminal beep and warning are issued." @@ -310,14 +310,14 @@ split then a terminal beep and warning are issued." :type 'boolean) (defcustom idlwave-no-change-comment ";;;" - "*The indentation of a comment that starts with this regular + "The indentation of a comment that starts with this regular expression will not be changed. Note that the indentation of a comment at the beginning of a line is never changed." :group 'idlwave-code-formatting :type 'string) (defcustom idlwave-begin-line-comment nil - "*A comment anchored at the beginning of line. + "A comment anchored at the beginning of line. A comment matching this regular expression will not have its indentation changed. If nil the default is \"^;\", i.e., any line beginning with a \";\". Expressions for comments at the beginning of @@ -327,7 +327,7 @@ the line should begin with \"^\"." 'regexp)) (defcustom idlwave-code-comment ";;[^;]" - "*A comment that starts with this regular expression on a line by + "A comment that starts with this regular expression on a line by itself is indented as if it is a part of IDL code. As a result if the comment is not preceded by whitespace it is unchanged." :group 'idlwave-code-formatting @@ -343,7 +343,7 @@ the comment is not preceded by whitespace it is unchanged." :group 'idlwave) (defcustom idlwave-use-library-catalogs t - "*Non-nil means search the IDL path for library catalog files. + "Non-nil means search the IDL path for library catalog files. These files, named .idlwave_catalog, document routine information for individual directories and libraries of IDL .pro files. Many popular @@ -353,7 +353,7 @@ usually a good idea." :type 'boolean) (defcustom idlwave-init-rinfo-when-idle-after 10 - "*Seconds of idle time before routine info is automatically initialized. + "Seconds of idle time before routine info is automatically initialized. Initializing the routine info can take a long time, in particular if a large number of library catalogs are involved. When Emacs is idle for more than the number of seconds specified by this variable, it starts @@ -370,7 +370,7 @@ needed, and initialize then." :type 'number) (defcustom idlwave-scan-all-buffers-for-routine-info t - "*Non-nil means, scan buffers for IDL programs when updating info. + "Non-nil means, scan buffers for IDL programs when updating info. The scanning is done by the command `idlwave-update-routine-info'. The following values are allowed: @@ -384,7 +384,7 @@ current Scan only the current buffer, but no other buffers." (const :tag "Current buffer only" 'current))) (defcustom idlwave-query-shell-for-routine-info t - "*Non-nil means query the shell for info about compiled routines. + "Non-nil means query the shell for info about compiled routines. Querying the shell is useful to get information about compiled modules, and it is turned on by default. However, when you have a complete library scan, this is not necessary." @@ -393,7 +393,7 @@ scan, this is not necessary." (defcustom idlwave-auto-routine-info-updates '(find-file save-buffer kill-buffer compile-buffer) - "*Controls under what circumstances routine info is updated automatically. + "Controls under what circumstances routine info is updated automatically. Possible values: nil Never t All available @@ -413,7 +413,7 @@ t All available (const :tag "After a buffer was compiled successfully, update shell info" compile-buffer)))) (defcustom idlwave-rinfo-max-source-lines 5 - "*Maximum number of source files displayed in the Routine Info window. + "Maximum number of source files displayed in the Routine Info window. When an integer, it is the maximum number of source files displayed. A value of t means to show all source files." :group 'idlwave-routine-info @@ -448,7 +448,7 @@ value of `!DIR'. See also `idlwave-library-path'." ;; Configuration files (defcustom idlwave-config-directory (convert-standard-filename "~/.idlwave") - "*Directory for configuration files and user-library catalog." + "Directory for configuration files and user-library catalog." :group 'idlwave-routine-info :type 'file) @@ -457,7 +457,7 @@ value of `!DIR'. See also `idlwave-library-path'." (defvar idlwave-path-file "idlpath.el") (defvar idlwave-libinfo-file nil - "*Obsolete variable, no longer used.") + "Obsolete variable, no longer used.") (defcustom idlwave-special-lib-alist nil "Alist of regular expressions matching special library directories. @@ -538,7 +538,7 @@ After changing this variable, you need to either restart Emacs or press ,idlwave-tmp))) (defcustom idlwave-completion-force-default-case nil - "*Non-nil means, completion will always honor `idlwave-completion-case'. + "Non-nil means, completion will always honor `idlwave-completion-case'. When nil, only the completion of a mixed case or upper case string will honor the default settings in `idlwave-completion-case', while the completion of lower case strings will be completed entirely in @@ -547,7 +547,7 @@ lower case." :type 'boolean) (defcustom idlwave-complete-empty-string-as-lower-case nil - "*Non-nil means, the empty string is considered downcase for completion. + "Non-nil means, the empty string is considered downcase for completion. The case of what is already in the buffer determines the case of completions. When this variable is non-nil, the empty string is considered to be downcase. Completing on the empty string then offers downcase versions of the possible @@ -560,7 +560,7 @@ completions." `idlwave-completion-case'.") (defcustom idlwave-buffer-case-takes-precedence nil - "*Non-nil means, the case of tokens in buffers dominates over system stuff. + "Non-nil means, the case of tokens in buffers dominates over system stuff. To make this possible, we need to re-case everything each time we update the routine info from the buffers. This is slow. The default is to consider the case given in the system and library files @@ -569,7 +569,7 @@ first which makes updating much faster." :type 'boolean) (defcustom idlwave-highlight-help-links-in-completion t - "*Non-nil means, highlight completions for which system help is available. + "Non-nil means, highlight completions for which system help is available. Help can then be accessed with mouse-3. This option is only effective when the online help system is installed." :group 'idlwave-completion @@ -594,7 +594,7 @@ for which to assume this can be set here." (defcustom idlwave-completion-show-classes 1 - "*Number of classes to show when completing object methods and keywords. + "Number of classes to show when completing object methods and keywords. When completing methods or keywords for an object with unknown class, the *Completions* buffer will show the valid classes for each completion like this: @@ -613,7 +613,7 @@ negative integer, the `help-echo' property will be suppressed." (integer :tag "Number of classes shown" 1))) (defcustom idlwave-completion-fontify-classes t - "*Non-nil means, fontify the classes in completions buffer. + "Non-nil means, fontify the classes in completions buffer. This makes it easier to distinguish the completion items from the extra class info listed. See `idlwave-completion-show-classes'." :group 'idlwave-completion @@ -673,7 +673,7 @@ method, add an entry (\"INIT\" . t). The method name must be ALL-CAPS." (boolean :tag "Determine class for this method"))))) (defcustom idlwave-store-inquired-class t - "*Non-nil means, store class of a method call as text property on `->'. + "Non-nil means, store class of a method call as text property on `->'. IDLWAVE sometimes has to ask the user for the class associated with a particular object method call. This happens during the commands `idlwave-routine-info' and `idlwave-complete', depending upon the @@ -698,7 +698,7 @@ at point." :type 'boolean) (defcustom idlwave-class-arrow-face 'bold - "*Face to highlight object operator arrows `->' which carry a class property. + "Face to highlight object operator arrows `->' which carry a class property. When IDLWAVE stores a class name as text property on an object arrow \(see variable `idlwave-store-inquired-class', it highlights the arrow with this font in order to remind the user that this arrow is special." @@ -706,17 +706,17 @@ with this font in order to remind the user that this arrow is special." :type 'symbol) (defcustom idlwave-resize-routine-help-window t - "*Non-nil means, resize the Routine-info *Help* window to fit the content." + "Non-nil means, resize the Routine-info *Help* window to fit the content." :group 'idlwave-completion :type 'boolean) (defcustom idlwave-keyword-completion-adds-equal t - "*Non-nil means, completion automatically adds `=' after completed keywords." + "Non-nil means, completion automatically adds `=' after completed keywords." :group 'idlwave-completion :type 'boolean) (defcustom idlwave-function-completion-adds-paren t - "*Non-nil means, completion automatically adds `(' after completed function. + "Non-nil means, completion automatically adds `(' after completed function. nil means, don't add anything. A value of `2' means, also add the closing parenthesis and position cursor between the two." @@ -726,7 +726,7 @@ between the two." (const :tag "()" 2))) (defcustom idlwave-completion-restore-window-configuration t - "*Non-nil means, try to restore the window configuration after completion. + "Non-nil means, try to restore the window configuration after completion. When completion is not unique, Emacs displays a list of completions. This messes up your window configuration. With this variable set, IDLWAVE restores the old configuration after successful completion." @@ -741,13 +741,13 @@ The variables in this group govern this." :group 'idlwave) (defcustom idlwave-do-actions nil - "*Non-nil means performs actions when indenting. + "Non-nil means performs actions when indenting. The actions that can be performed are listed in `idlwave-indent-action-table'." :group 'idlwave-abbrev-and-indent-action :type 'boolean) (defcustom idlwave-abbrev-start-char "\\" - "*A single character string used to start abbreviations in abbrev mode. + "A single character string used to start abbreviations in abbrev mode. Possible characters to chose from: ~`\% or even '?'. '.' is not a good choice because it can make structure field names act like abbrevs in certain circumstances. @@ -759,7 +759,7 @@ is loaded." :type 'string) (defcustom idlwave-surround-by-blank nil - "*Non-nil means, enable `idlwave-surround'. + "Non-nil means, enable `idlwave-surround'. If non-nil, `=',`<',`>',`&',`,', `->' are surrounded with spaces by `idlwave-surround'. See help for `idlwave-indent-action-table' for symbols using `idlwave-surround'. @@ -774,7 +774,7 @@ Also see help for `idlwave-surround'." :type 'boolean) (defcustom idlwave-pad-keyword t - "*Non-nil means pad '=' in keywords (routine calls or defs) like assignment. + "Non-nil means pad '=' in keywords (routine calls or defs) like assignment. Whenever `idlwave-surround' is non-nil then this affects how '=' is padded for keywords and for variables. If t, pad the same as for assignments. If nil then spaces are removed. With any other value, @@ -786,22 +786,22 @@ spaces are left unchanged." (const :tag "Keep space near `='" 'keep))) (defcustom idlwave-show-block t - "*Non-nil means point blinks to block beginning for `idlwave-show-begin'." + "Non-nil means point blinks to block beginning for `idlwave-show-begin'." :group 'idlwave-abbrev-and-indent-action :type 'boolean) (defcustom idlwave-expand-generic-end nil - "*Non-nil means expand generic END to ENDIF/ENDELSE/ENDWHILE etc." + "Non-nil means expand generic END to ENDIF/ENDELSE/ENDWHILE etc." :group 'idlwave-abbrev-and-indent-action :type 'boolean) (defcustom idlwave-reindent-end t - "*Non-nil means re-indent line after END was typed." + "Non-nil means re-indent line after END was typed." :group 'idlwave-abbrev-and-indent-action :type 'boolean) (defcustom idlwave-abbrev-move t - "*Non-nil means the abbrev hook can move point. + "Non-nil means the abbrev hook can move point. Set to nil by `idlwave-expand-region-abbrevs'. To see the abbrev definitions, use the command `list-abbrevs', for abbrevs that move point. Moving point is useful, for example, to place point between @@ -812,7 +812,7 @@ See `idlwave-check-abbrev'." :type 'boolean) (defcustom idlwave-abbrev-change-case nil - "*Non-nil means all abbrevs will be forced to either upper or lower case. + "Non-nil means all abbrevs will be forced to either upper or lower case. If the value t, all expanded abbrevs will be upper case. If the value is 'down then abbrevs will be forced to lower case. If nil, the case will not change. @@ -822,7 +822,7 @@ upper case, regardless of this variable." :type 'boolean) (defcustom idlwave-reserved-word-upcase nil - "*Non-nil means, reserved words will be made upper case via abbrev expansion. + "Non-nil means, reserved words will be made upper case via abbrev expansion. If nil case of reserved words is controlled by `idlwave-abbrev-change-case'. Has effect only if in abbrev-mode." :group 'idlwave-abbrev-and-indent-action @@ -859,7 +859,7 @@ Has effect only if in abbrev-mode." ;; '(capitalize-word -1) t) (defvar idlwave-indent-action-table nil - "*Associated array containing action lists of search string (car), + "Associated array containing action lists of search string (car), and function as a cdr. This table is used by `idlwave-indent-line'. See documentation for `idlwave-do-action' for a complete description of the action lists. @@ -869,7 +869,7 @@ binding is not requested. See help on `idlwave-action-and-binding' for examples.") (defvar idlwave-indent-expand-table nil - "*Associated array containing action lists of search string (car), + "Associated array containing action lists of search string (car), and function as a cdr. The table is used by the `idlwave-indent-and-action' function. See documentation for `idlwave-do-action' for a complete description of the action lists. @@ -948,14 +948,14 @@ See help on `idlwave-action-and-binding' for examples.") ; ;- ") - "*A list (PATHNAME STRING) specifying the doc-header template to use for + "A list (PATHNAME STRING) specifying the doc-header template to use for summarizing a file. If PATHNAME is non-nil then this file will be included. Otherwise STRING is used. If nil, the file summary will be omitted. For example you might set PATHNAME to the path for the lib_template.pro file included in the IDL distribution.") (defcustom idlwave-header-to-beginning-of-file t - "*Non-nil means, the documentation header will always be at start of file. + "Non-nil means, the documentation header will always be at start of file. When nil, the header is positioned between the PRO/FUNCTION line of the current routine and the code, allowing several routine headers in a file." @@ -963,12 +963,12 @@ a file." :type 'boolean) (defcustom idlwave-timestamp-hook 'idlwave-default-insert-timestamp - "*The hook function used to update the timestamp of a function." + "The hook function used to update the timestamp of a function." :group 'idlwave-documentation :type 'function) (defcustom idlwave-doc-modifications-keyword "HISTORY" - "*The modifications keyword to use with the log documentation commands. + "The modifications keyword to use with the log documentation commands. A ':' is added to the keyword end. Inserted by doc-header and used to position logs by doc-modification. If nil it will not be inserted." @@ -976,12 +976,12 @@ If nil it will not be inserted." :type 'string) (defcustom idlwave-doclib-start "^;+\\+" - "*Regexp matching the start of a document library header." + "Regexp matching the start of a document library header." :group 'idlwave-documentation :type 'regexp) (defcustom idlwave-doclib-end "^;+-" - "*Regexp matching the end of a document library header." + "Regexp matching the end of a document library header." :group 'idlwave-documentation :type 'regexp) @@ -992,7 +992,7 @@ If nil it will not be inserted." :group 'idlwave) (defcustom idlwave-shell-explicit-file-name "idl" - "*If non-nil, this is the command to run IDL. + "If non-nil, this is the command to run IDL. Should be an absolute file path or path relative to the current environment execution search path. If you want to specify command line switches for the IDL program, use `idlwave-shell-command-line-options'. @@ -1003,7 +1003,7 @@ it without compromising backwards-compatibility." :type 'string) (defcustom idlwave-shell-command-line-options nil - "*A list of command line options for calling the IDL program. + "A list of command line options for calling the IDL program. Since IDL is executed directly without going through a shell like /bin/sh, this should be a list of strings like '(\"-rt=file\" \"-nw\") with a separate string for each argument. But you may also give a single string which @@ -1015,7 +1015,7 @@ split it for you." :group 'idlwave-external-programs) (defcustom idlwave-help-application "idlhelp" - "*The external application providing reference help for programming. + "The external application providing reference help for programming. Obsolete, if the IDL Assistant is being used for help." :group 'idlwave-external-programs :type 'string) @@ -1040,7 +1040,7 @@ are `control', `meta', `super', `hyper', `alt', and `shift'." (const shift))) (defcustom idlwave-shell-automatic-start nil - "*If non-nil attempt invoke `idlwave-shell' if not already running. + "If non-nil attempt invoke `idlwave-shell' if not already running. This is checked when an attempt to send a command to an IDL process is made." :group 'idlwave-shell-general-setup @@ -1054,7 +1054,7 @@ IDL process is made." :group 'idlwave) (defcustom idlwave-startup-message t - "*Non-nil displays a startup message when `idlwave-mode' is first called." + "Non-nil displays a startup message when `idlwave-mode' is first called." :group 'idlwave-misc :type 'boolean) diff --git a/lisp/progmodes/inf-lisp.el b/lisp/progmodes/inf-lisp.el index 73e167d1587..cd6c8869d9f 100644 --- a/lisp/progmodes/inf-lisp.el +++ b/lisp/progmodes/inf-lisp.el @@ -72,7 +72,7 @@ ;;;###autoload (defcustom inferior-lisp-filter-regexp (purecopy "\\`\\s *\\(:\\(\\w\\|\\s_\\)\\)?\\s *\\'") - "*What not to save on inferior Lisp's input history. + "What not to save on inferior Lisp's input history. Input matching this regexp is not saved on the input history in Inferior Lisp mode. Default is whitespace followed by 0 or 1 single-letter colon-keyword \(as in :a, :c, etc.)" @@ -139,13 +139,13 @@ mode. Default is whitespace followed by 0 or 1 single-letter colon-keyword ;;;###autoload (defcustom inferior-lisp-program (purecopy "lisp") - "*Program name for invoking an inferior Lisp in Inferior Lisp mode." + "Program name for invoking an inferior Lisp in Inferior Lisp mode." :type 'string :group 'inferior-lisp) ;;;###autoload (defcustom inferior-lisp-load-command (purecopy "(load \"%s\")\n") - "*Format-string for building a Lisp expression to load a file. + "Format-string for building a Lisp expression to load a file. This format string should use `%s' to substitute a file name and should result in a Lisp expression that will command the inferior Lisp to load that file. The default works acceptably on most Lisps. @@ -211,7 +211,7 @@ buffer with \\[set-variable].") ;;;###autoload (defvar inferior-lisp-mode-hook '() - "*Hook for customizing Inferior Lisp mode.") + "Hook for customizing Inferior Lisp mode.") (put 'inferior-lisp-mode 'mode-class 'special) @@ -453,7 +453,7 @@ This holds a cons cell of the form `(DIRECTORY . FILE)' describing the last `lisp-load-file' or `lisp-compile-file' command.") (defcustom lisp-source-modes '(lisp-mode) - "*Used to determine if a buffer contains Lisp source code. + "Used to determine if a buffer contains Lisp source code. If it's loaded into a buffer that is in one of these major modes, it's considered a Lisp source file by `lisp-load-file' and `lisp-compile-file'. Used by these commands to determine defaults." diff --git a/lisp/progmodes/m4-mode.el b/lisp/progmodes/m4-mode.el index b1884bd105b..20f91ce2d9e 100644 --- a/lisp/progmodes/m4-mode.el +++ b/lisp/progmodes/m4-mode.el @@ -80,7 +80,7 @@ "Default font-lock-keywords for `m4 mode'.") (defcustom m4-mode-hook nil - "*Hook called by `m4-mode'." + "Hook called by `m4-mode'." :type 'hook :group 'm4) diff --git a/lisp/progmodes/make-mode.el b/lisp/progmodes/make-mode.el index b4ca1ba665f..a173b11500e 100644 --- a/lisp/progmodes/make-mode.el +++ b/lisp/progmodes/make-mode.el @@ -129,18 +129,18 @@ :version "22.1") (defcustom makefile-browser-buffer-name "*Macros and Targets*" - "*Name of the macro- and target browser buffer." + "Name of the macro- and target browser buffer." :type 'string :group 'makefile) (defcustom makefile-target-colon ":" - "*String to append to all target names inserted by `makefile-insert-target'. + "String to append to all target names inserted by `makefile-insert-target'. \":\" or \"::\" are common values." :type 'string :group 'makefile) (defcustom makefile-macro-assign " = " - "*String to append to all macro names inserted by `makefile-insert-macro'. + "String to append to all macro names inserted by `makefile-insert-macro'. The normal value should be \" = \", since this is what standard make expects. However, newer makes such as dmake allow a larger variety of different macro assignments, so you @@ -149,69 +149,69 @@ might prefer to use \" += \" or \" := \" ." :group 'makefile) (defcustom makefile-electric-keys nil - "*If non-nil, Makefile mode should install electric keybindings. + "If non-nil, Makefile mode should install electric keybindings. Default is nil." :type 'boolean :group 'makefile) (defcustom makefile-use-curly-braces-for-macros-p nil - "*Controls the style of generated macro references. + "Controls the style of generated macro references. Non-nil means macro references should use curly braces, like `${this}'. nil means use parentheses, like `$(this)'." :type 'boolean :group 'makefile) (defcustom makefile-tab-after-target-colon t - "*If non-nil, insert a TAB after a target colon. + "If non-nil, insert a TAB after a target colon. Otherwise, a space is inserted. The default is t." :type 'boolean :group 'makefile) (defcustom makefile-browser-leftmost-column 10 - "*Number of blanks to the left of the browser selection mark." + "Number of blanks to the left of the browser selection mark." :type 'integer :group 'makefile) (defcustom makefile-browser-cursor-column 10 - "*Column the cursor goes to when it moves up or down in the Makefile browser." + "Column the cursor goes to when it moves up or down in the Makefile browser." :type 'integer :group 'makefile) (defcustom makefile-backslash-column 48 - "*Column in which `makefile-backslash-region' inserts backslashes." + "Column in which `makefile-backslash-region' inserts backslashes." :type 'integer :group 'makefile) (defcustom makefile-backslash-align t - "*If non-nil, `makefile-backslash-region' will align backslashes." + "If non-nil, `makefile-backslash-region' will align backslashes." :type 'boolean :group 'makefile) (defcustom makefile-browser-selected-mark "+ " - "*String used to mark selected entries in the Makefile browser." + "String used to mark selected entries in the Makefile browser." :type 'string :group 'makefile) (defcustom makefile-browser-unselected-mark " " - "*String used to mark unselected entries in the Makefile browser." + "String used to mark unselected entries in the Makefile browser." :type 'string :group 'makefile) (defcustom makefile-browser-auto-advance-after-selection-p t - "*If non-nil, cursor will move after item is selected in Makefile browser." + "If non-nil, cursor will move after item is selected in Makefile browser." :type 'boolean :group 'makefile) (defcustom makefile-pickup-everything-picks-up-filenames-p nil - "*If non-nil, `makefile-pickup-everything' picks up filenames as targets. + "If non-nil, `makefile-pickup-everything' picks up filenames as targets. This means it calls `makefile-pickup-filenames-as-targets'. Otherwise filenames are omitted." :type 'boolean :group 'makefile) (defcustom makefile-cleanup-continuations nil - "*If non-nil, automatically clean up continuation lines when saving. + "If non-nil, automatically clean up continuation lines when saving. A line is cleaned up by removing all whitespace following a trailing backslash. This is done silently. IMPORTANT: Please note that enabling this option causes Makefile mode @@ -220,7 +220,7 @@ to MODIFY A FILE WITHOUT YOUR CONFIRMATION when \"it seems necessary\"." :group 'makefile) (defcustom makefile-mode-hook nil - "*Normal hook run by `makefile-mode'." + "Normal hook run by `makefile-mode'." :type 'hook :group 'makefile) @@ -247,7 +247,7 @@ you enter a \".\" at the beginning of a line in `makefile-mode'." (defcustom makefile-runtime-macros-list '(("@") ("&") (">") ("<") ("*") ("^") ("+") ("?") ("%") ("$")) - "*List of macros that are resolved by make at runtime. + "List of macros that are resolved by make at runtime. If you insert a macro reference using `makefile-insert-macro-ref', the name of the macro is checked against this list. If it can be found its name will not be enclosed in { } or ( )." @@ -553,14 +553,14 @@ not be enclosed in { } or ( )." ;; ------------------------------------------------------------ (defcustom makefile-brave-make "make" - "*How to invoke make, for `makefile-query-targets'. + "How to invoke make, for `makefile-query-targets'. This should identify a `make' command that can handle the `-q' option." :type 'string :group 'makefile) (defcustom makefile-query-one-target-method-function 'makefile-query-by-make-minus-q - "*Function to call to determine whether a make target is up to date. + "Function to call to determine whether a make target is up to date. The function must satisfy this calling convention: * As its first argument, it must accept the name of the target to @@ -579,7 +579,7 @@ The function must satisfy this calling convention: 'makefile-query-one-target-method-function) (defcustom makefile-up-to-date-buffer-name "*Makefile Up-to-date overview*" - "*Name of the Up-to-date overview buffer." + "Name of the Up-to-date overview buffer." :type 'string :group 'makefile) diff --git a/lisp/progmodes/modula2.el b/lisp/progmodes/modula2.el index 0c43a3ed354..d634efebe5b 100644 --- a/lisp/progmodes/modula2.el +++ b/lisp/progmodes/modula2.el @@ -65,7 +65,7 @@ :group 'modula2) (defcustom m2-end-comment-column 75 - "*Column for aligning the end of a comment, in Modula-2." + "Column for aligning the end of a comment, in Modula-2." :type 'integer :group 'modula2) @@ -104,7 +104,7 @@ "Keymap used in Modula-2 mode.") (defcustom m2-indent 5 - "*This variable gives the indentation in Modula-2-Mode." + "This variable gives the indentation in Modula-2-Mode." :type 'integer :group 'modula2) (put 'm2-indent 'safe-local-variable diff --git a/lisp/progmodes/octave-inf.el b/lisp/progmodes/octave-inf.el index 2cae41889bd..f77e24e665a 100644 --- a/lisp/progmodes/octave-inf.el +++ b/lisp/progmodes/octave-inf.el @@ -79,7 +79,7 @@ mode, set this to (\"-q\" \"--traditional\")." "Syntax table in use in inferior-octave-mode buffers.") (defcustom inferior-octave-mode-hook nil - "*Hook to be run when Inferior Octave mode is started." + "Hook to be run when Inferior Octave mode is started." :type 'hook :group 'octave-inferior) diff --git a/lisp/progmodes/pascal.el b/lisp/progmodes/pascal.el index 95f1adec40e..8f7f313753c 100644 --- a/lisp/progmodes/pascal.el +++ b/lisp/progmodes/pascal.el @@ -183,42 +183,42 @@ (put 'pascal-mode 'font-lock-defaults '(pascal-font-lock-keywords nil t)) (defcustom pascal-indent-level 3 - "*Indentation of Pascal statements with respect to containing block." + "Indentation of Pascal statements with respect to containing block." :type 'integer :group 'pascal) (defcustom pascal-case-indent 2 - "*Indentation for case statements." + "Indentation for case statements." :type 'integer :group 'pascal) (defcustom pascal-auto-newline nil - "*Non-nil means automatically insert newlines in certain cases. + "Non-nil means automatically insert newlines in certain cases. These include after semicolons and after the punctuation mark after an `end'." :type 'boolean :group 'pascal) (defcustom pascal-indent-nested-functions t - "*Non-nil means nested functions are indented." + "Non-nil means nested functions are indented." :type 'boolean :group 'pascal) (defcustom pascal-tab-always-indent t - "*Non-nil means TAB in Pascal mode should always reindent the current line. + "Non-nil means TAB in Pascal mode should always reindent the current line. If this is nil, TAB inserts a tab if it is at the end of the line and follows non-whitespace text." :type 'boolean :group 'pascal) (defcustom pascal-auto-endcomments t - "*Non-nil means automatically insert comments after certain `end's. + "Non-nil means automatically insert comments after certain `end's. Specifically, this is done after the ends of cases statements and functions. The name of the function or case is included between the braces." :type 'boolean :group 'pascal) (defcustom pascal-auto-lineup '(all) - "*List of contexts where auto lineup of :'s or ='s should be done. + "List of contexts where auto lineup of :'s or ='s should be done. Elements can be of type: 'paramlist', 'declaration' or 'case', which will do auto lineup in parameterlist, declarations or case-statements respectively. The word 'all' will do all lineups. '(case paramlist) for @@ -232,7 +232,7 @@ will do all lineups." :group 'pascal) (defvar pascal-toggle-completions nil - "*Non-nil meant \\<pascal-mode-map>\\[pascal-complete-word] would try all possible completions one by one. + "Non-nil meant \\<pascal-mode-map>\\[pascal-complete-word] would try all possible completions one by one. Repeated use of \\[pascal-complete-word] would show you all of them. Normally, when there is more than one possible completion, it displays a list of all possible completions.") @@ -241,7 +241,7 @@ it displays a list of all possible completions.") (defcustom pascal-type-keywords '("array" "file" "packed" "char" "integer" "real" "string" "record") - "*Keywords for types used when completing a word in a declaration or parmlist. + "Keywords for types used when completing a word in a declaration or parmlist. These include integer, real, char, etc. The types defined within the Pascal program are handled in another way, and should not be added to this list." @@ -251,7 +251,7 @@ are handled in another way, and should not be added to this list." (defcustom pascal-start-keywords '("begin" "end" "function" "procedure" "repeat" "until" "while" "read" "readln" "reset" "rewrite" "write" "writeln") - "*Keywords to complete when standing at the first word of a statement. + "Keywords to complete when standing at the first word of a statement. These are keywords such as begin, repeat, until, readln. The procedures and variables defined within the Pascal program are handled in another way, and should not be added to this list." @@ -260,7 +260,7 @@ are handled in another way, and should not be added to this list." (defcustom pascal-separator-keywords '("downto" "else" "mod" "div" "then") - "*Keywords to complete when NOT standing at the first word of a statement. + "Keywords to complete when NOT standing at the first word of a statement. These are keywords such as downto, else, mod, then. Variables and function names defined within the Pascal program are handled in another way, and should not be added to this list." diff --git a/lisp/progmodes/perl-mode.el b/lisp/progmodes/perl-mode.el index 26c6e5a9f03..aab5f8f65a4 100644 --- a/lisp/progmodes/perl-mode.el +++ b/lisp/progmodes/perl-mode.el @@ -468,7 +468,7 @@ The expansion is entirely correct because it uses the C preprocessor." (t (funcall (default-value 'font-lock-syntactic-face-function) state)))) (defcustom perl-indent-level 4 - "*Indentation of Perl statements with respect to containing block." + "Indentation of Perl statements with respect to containing block." :type 'integer :group 'perl) @@ -485,28 +485,28 @@ The expansion is entirely correct because it uses the C preprocessor." ;;;###autoload(put 'perl-label-offset 'safe-local-variable 'integerp) (defcustom perl-continued-statement-offset 4 - "*Extra indent for lines not starting new statements." + "Extra indent for lines not starting new statements." :type 'integer :group 'perl) (defcustom perl-continued-brace-offset -4 - "*Extra indent for substatements that start with open-braces. + "Extra indent for substatements that start with open-braces. This is in addition to `perl-continued-statement-offset'." :type 'integer :group 'perl) (defcustom perl-brace-offset 0 - "*Extra indentation for braces, compared with other text in same context." + "Extra indentation for braces, compared with other text in same context." :type 'integer :group 'perl) (defcustom perl-brace-imaginary-offset 0 - "*Imagined indentation of an open brace that actually follows a statement." + "Imagined indentation of an open brace that actually follows a statement." :type 'integer :group 'perl) (defcustom perl-label-offset -2 - "*Offset of Perl label lines relative to usual indentation." + "Offset of Perl label lines relative to usual indentation." :type 'integer :group 'perl) (defcustom perl-indent-continued-arguments nil - "*If non-nil offset of argument lines relative to usual indentation. + "If non-nil offset of argument lines relative to usual indentation. If nil, continued arguments are aligned with the first argument." :type '(choice integer (const nil)) :group 'perl) @@ -521,7 +521,7 @@ nonwhite character on the line." ;; I changed the default to nil for consistency with general Emacs ;; conventions -- rms. (defcustom perl-tab-to-comment nil - "*Non-nil means TAB moves to eol or makes a comment in some cases. + "Non-nil means TAB moves to eol or makes a comment in some cases. For lines which don't need indenting, TAB either indents an existing comment, moves to end-of-line, or if at end-of-line already, create a new comment." @@ -529,7 +529,7 @@ create a new comment." :group 'perl) (defcustom perl-nochange ";?#\\|\f\\|\\s(\\|\\(\\w\\|\\s_\\)+:[^:]" - "*Lines starting with this regular expression are not auto-indented." + "Lines starting with this regular expression are not auto-indented." :type 'regexp :group 'perl) diff --git a/lisp/progmodes/prolog.el b/lisp/progmodes/prolog.el index a8ee6f4bff4..74c8c31b425 100644 --- a/lisp/progmodes/prolog.el +++ b/lisp/progmodes/prolog.el @@ -3621,12 +3621,12 @@ a new comment is created." (indent-for-comment))) (defun prolog-indent-predicate () - "*Indent the current predicate." + "Indent the current predicate." (interactive) (indent-region (prolog-pred-start) (prolog-pred-end) nil)) (defun prolog-indent-buffer () - "*Indent the entire buffer." + "Indent the entire buffer." (interactive) (indent-region (point-min) (point-max) nil)) diff --git a/lisp/progmodes/ps-mode.el b/lisp/progmodes/ps-mode.el index e85fa0476b0..bf52eff8f9a 100644 --- a/lisp/progmodes/ps-mode.el +++ b/lisp/progmodes/ps-mode.el @@ -60,17 +60,17 @@ ;; User variables. (defcustom ps-mode-auto-indent t - "*Should we use autoindent?" + "Should we use autoindent?" :group 'PostScript-edit :type 'boolean) (defcustom ps-mode-tab 4 - "*Number of spaces to use when indenting." + "Number of spaces to use when indenting." :group 'PostScript-edit :type 'integer) (defcustom ps-mode-paper-size '(595 842) - "*Default paper size. + "Default paper size. When inserting an EPSF template these values are used to set the boundingbox to include the whole page. @@ -117,12 +117,12 @@ When the figure is finished these values should be replaced." (lpr-command (if (memq system-type '(usg-unix-v hpux irix)) "lp" "lpr"))) (lpr-buffer))) - "*Lisp function to print current buffer as PostScript." + "Lisp function to print current buffer as PostScript." :group 'PostScript-edit :type 'function) (defcustom ps-run-prompt "\\(GS\\(<[0-9]+\\)?>\\)+" - "*Regexp to match prompt in interactive PostScript." + "Regexp to match prompt in interactive PostScript." :group 'PostScript-interaction :type 'regexp) @@ -139,7 +139,7 @@ When the figure is finished these values should be replaced." ("^\\(Current file position is\\) \\([0-9]+\\)" (1 font-lock-comment-face nil nil) (2 font-lock-warning-face nil nil)))) - "*Medium level highlighting of messages from the PostScript interpreter. + "Medium level highlighting of messages from the PostScript interpreter. See documentation on font-lock for details." :group 'PostScript-interaction @@ -155,17 +155,17 @@ See documentation on font-lock for details." (boolean :tag "Laxmatch" :value t)))))) (defcustom ps-run-x '("gs" "-r72" "-sPAPERSIZE=a4") - "*Command as list to run PostScript with graphic display." + "Command as list to run PostScript with graphic display." :group 'PostScript-interaction :type '(repeat string)) (defcustom ps-run-dumb '("gs" "-dNODISPLAY") - "*Command as list to run PostScript without graphic display." + "Command as list to run PostScript without graphic display." :group 'PostScript-interaction :type '(repeat string)) (defcustom ps-run-init nil - "*String of commands to send to PostScript to start interactive. + "String of commands to send to PostScript to start interactive. Example: \"executive\" @@ -174,13 +174,13 @@ You won't need to set this option for Ghostscript." :type '(choice (const nil) string)) (defcustom ps-run-error-line-numbers nil - "*What values are used by the PostScript interpreter in error messages?" + "What values are used by the PostScript interpreter in error messages?" :group 'PostScript-interaction :type '(choice (const :tag "line numbers" t) (const :tag "byte counts" nil))) (defcustom ps-run-tmp-dir nil - "*Name of directory to place temporary file. + "Name of directory to place temporary file. If nil, use `temporary-file-directory'." :group 'PostScript-interaction :type '(choice (const nil) directory)) diff --git a/lisp/progmodes/python.el b/lisp/progmodes/python.el index 3ef872d26eb..f7566c31b41 100644 --- a/lisp/progmodes/python.el +++ b/lisp/progmodes/python.el @@ -494,7 +494,7 @@ statement." (defcustom python-pdbtrack-do-tracking-p t - "*Controls whether the pdbtrack feature is enabled or not. + "Controls whether the pdbtrack feature is enabled or not. When non-nil, pdbtrack is enabled in all comint-based buffers, e.g. shell interaction buffers and the *Python* buffer. @@ -509,7 +509,7 @@ having to restart the program." (make-variable-buffer-local 'python-pdbtrack-do-tracking-p) (defcustom python-pdbtrack-minor-mode-string " PDB" - "*Minor-mode sign to be displayed when pdbtrack is active." + "Minor-mode sign to be displayed when pdbtrack is active." :type 'string :group 'python) @@ -1288,7 +1288,7 @@ modified by the user. Additional arguments are added when the command is used by `run-python' et al.") (defvar python-buffer nil - "*The current Python process buffer. + "The current Python process buffer. Commands that send text from source buffers to Python processes have to choose a process to send to. This is determined by buffer-local diff --git a/lisp/progmodes/scheme.el b/lisp/progmodes/scheme.el index 82a4985015f..1fa75f239eb 100644 --- a/lisp/progmodes/scheme.el +++ b/lisp/progmodes/scheme.el @@ -229,7 +229,7 @@ Set this to nil if you normally use another dialect." (defcustom dsssl-sgml-declaration "<!DOCTYPE style-sheet PUBLIC \"-//James Clark//DTD DSSSL Style Sheet//EN\"> " - "*An SGML declaration for the DSSSL file. + "An SGML declaration for the DSSSL file. If it is defined as a string this will be inserted into an empty buffer which is in `dsssl-mode'. It is typically James Clark's style-sheet doctype, as required for Jade." @@ -251,7 +251,7 @@ See `run-hooks'." ;; This is shared by cmuscheme and xscheme. (defcustom scheme-program-name "scheme" - "*Program invoked by the `run-scheme' command." + "Program invoked by the `run-scheme' command." :type 'string :group 'scheme) diff --git a/lisp/progmodes/sh-script.el b/lisp/progmodes/sh-script.el index 48b19524b8c..f60ce185bc7 100644 --- a/lisp/progmodes/sh-script.el +++ b/lisp/progmodes/sh-script.el @@ -1410,7 +1410,7 @@ This list is used when switching between buffer-local and global values of variables, and for the commands using indentation styles.") (defvar sh-make-vars-local t - "*Controls whether indentation variables are local to the buffer. + "Controls whether indentation variables are local to the buffer. If non-nil, indentation variables are made local initially. If nil, you can later make the variables local by invoking command `sh-make-vars-local'. @@ -1876,7 +1876,7 @@ region, clear header." ;; Indentation stuff. (defun sh-must-support-indent () - "*Signal an error if the shell type for this buffer is not supported. + "Signal an error if the shell type for this buffer is not supported. Also, the buffer must be in Shell-script mode." (unless sh-indent-supported-here (error "This buffer's shell does not support indentation through Emacs"))) @@ -2885,7 +2885,7 @@ so that `occur-next' and `occur-prev' will work." ;; Is this really worth having? (defvar sh-learned-buffer-hook nil - "*An abnormal hook, called with an alist of learned variables.") + "An abnormal hook, called with an alist of learned variables.") ;; Example of how to use sh-learned-buffer-hook ;; ;; (defun what-i-learned (list) diff --git a/lisp/progmodes/simula.el b/lisp/progmodes/simula.el index 7536126e8f1..2adb34c7824 100644 --- a/lisp/progmodes/simula.el +++ b/lisp/progmodes/simula.el @@ -48,7 +48,7 @@ Otherwise TAB indents only when point is within the run of whitespace at the beginning of the line.") (defcustom simula-tab-always-indent simula-tab-always-indent-default - "*Non-nil means TAB in SIMULA mode should always reindent the current line. + "Non-nil means TAB in SIMULA mode should always reindent the current line. Otherwise TAB indents only when point is within the run of whitespace at the beginning of the line." :type 'boolean @@ -58,7 +58,7 @@ the run of whitespace at the beginning of the line." "Indentation of SIMULA statements with respect to containing block.") (defcustom simula-indent-level simula-indent-level-default - "*Indentation of SIMULA statements with respect to containing block." + "Indentation of SIMULA statements with respect to containing block." :type 'integer :group 'simula) @@ -67,7 +67,7 @@ the run of whitespace at the beginning of the line." "Extra indentation after DO, THEN, ELSE, WHEN and OTHERWISE.") (defcustom simula-substatement-offset simula-substatement-offset-default - "*Extra indentation after DO, THEN, ELSE, WHEN and OTHERWISE." + "Extra indentation after DO, THEN, ELSE, WHEN and OTHERWISE." :type 'integer :group 'simula) @@ -79,7 +79,7 @@ the previous line of the statement.") (defcustom simula-continued-statement-offset simula-continued-statement-offset-default - "*Extra indentation for lines not starting a statement or substatement. + "Extra indentation for lines not starting a statement or substatement. If value is a list, each line in a multipleline continued statement will have the car of the list extra indentation with respect to the previous line of the statement." @@ -90,7 +90,7 @@ the previous line of the statement." "Offset of SIMULA label lines relative to usual indentation.") (defcustom simula-label-offset simula-label-offset-default - "*Offset of SIMULA label lines relative to usual indentation." + "Offset of SIMULA label lines relative to usual indentation." :type 'integer :group 'simula) @@ -100,7 +100,7 @@ Value is a cons cell, the car is extra THEN indentation and the cdr extra ELSE indentation. IF after ELSE is indented as the starting IF.") (defcustom simula-if-indent simula-if-indent-default - "*Extra indentation of THEN and ELSE with respect to the starting IF. + "Extra indentation of THEN and ELSE with respect to the starting IF. Value is a cons cell, the car is extra THEN indentation and the cdr extra ELSE indentation. IF after ELSE is indented as the starting IF." :type '(cons integer integer) @@ -112,7 +112,7 @@ Value is a cons cell, the car is extra WHEN indentation and the cdr extra OTHERWISE indentation.") (defcustom simula-inspect-indent simula-inspect-indent-default - "*Extra indentation of WHEN and OTHERWISE with respect to the INSPECT. + "Extra indentation of WHEN and OTHERWISE with respect to the INSPECT. Value is a cons cell, the car is extra WHEN indentation and the cdr extra OTHERWISE indentation." :type '(cons integer integer) @@ -122,7 +122,7 @@ and the cdr extra OTHERWISE indentation." "Non-nil means `simula-indent-line' function may reindent previous line.") (defcustom simula-electric-indent simula-electric-indent-default - "*Non-nil means `simula-indent-line' function may reindent previous line." + "Non-nil means `simula-indent-line' function may reindent previous line." :type 'boolean :group 'simula) @@ -132,7 +132,7 @@ Value is one of the symbols `upcase', `downcase', `capitalize', \(as in) `abbrev-table' or nil if they should not be changed.") (defcustom simula-abbrev-keyword simula-abbrev-keyword-default - "*Specify how to convert case for SIMULA keywords. + "Specify how to convert case for SIMULA keywords. Value is one of the symbols `upcase', `downcase', `capitalize', \(as in) `abbrev-table' or nil if they should not be changed." :type '(choice (const upcase) (const downcase) (const capitalize)(const nil)) @@ -144,7 +144,7 @@ Value is one of the symbols `upcase', `downcase', `capitalize', \(as in) `abbrev-table', or nil if they should not be changed.") (defcustom simula-abbrev-stdproc simula-abbrev-stdproc-default - "*Specify how to convert case for standard SIMULA procedure and class names. + "Specify how to convert case for standard SIMULA procedure and class names. Value is one of the symbols `upcase', `downcase', `capitalize', \(as in) `abbrev-table', or nil if they should not be changed." :type '(choice (const upcase) (const downcase) (const capitalize) @@ -152,7 +152,7 @@ Value is one of the symbols `upcase', `downcase', `capitalize', :group 'simula) (defcustom simula-abbrev-file nil - "*File with extra abbrev definitions for use in SIMULA mode. + "File with extra abbrev definitions for use in SIMULA mode. These are used together with the standard abbrev definitions for SIMULA. Please note that the standard definitions are required for SIMULA mode to function correctly." diff --git a/lisp/progmodes/tcl.el b/lisp/progmodes/tcl.el index 0198b32ec9f..f1ab01fd07f 100644 --- a/lisp/progmodes/tcl.el +++ b/lisp/progmodes/tcl.el @@ -120,24 +120,24 @@ :group 'languages) (defcustom tcl-indent-level 4 - "*Indentation of Tcl statements with respect to containing block." + "Indentation of Tcl statements with respect to containing block." :type 'integer :group 'tcl) (put 'tcl-indent-level 'safe-local-variable 'integerp) (defcustom tcl-continued-indent-level 4 - "*Indentation of continuation line relative to first line of command." + "Indentation of continuation line relative to first line of command." :type 'integer :group 'tcl) (put 'tcl-continued-indent-level 'safe-local-variable 'integerp) (defcustom tcl-auto-newline nil - "*Non-nil means automatically newline before and after braces you insert." + "Non-nil means automatically newline before and after braces you insert." :type 'boolean :group 'tcl) (defcustom tcl-tab-always-indent tab-always-indent - "*Control effect of TAB key. + "Control effect of TAB key. If t (the default), always indent current line. If nil and point is not in the indentation area at the beginning of the line, a TAB is inserted. @@ -157,7 +157,7 @@ to take place: (defcustom tcl-electric-hash-style nil ;; 'smart - "*Style of electric hash insertion to use. + "Style of electric hash insertion to use. Possible values are `backslash', meaning that `\\' quoting should be done; `quote', meaning that `\"' quoting should be done; `smart', meaning that the choice between `backslash' and `quote' should be @@ -168,27 +168,27 @@ taken to mean `smart'. The default is nil." :group 'tcl) (defcustom tcl-help-directory-list nil - "*List of topmost directories containing TclX help files." + "List of topmost directories containing TclX help files." :type '(repeat directory) :group 'tcl) (defcustom tcl-use-smart-word-finder t - "*If not nil, use smart way to find current word, for Tcl help feature." + "If not nil, use smart way to find current word, for Tcl help feature." :type 'boolean :group 'tcl) (defcustom tcl-application "wish" - "*Name of Tcl program to run in inferior Tcl mode." + "Name of Tcl program to run in inferior Tcl mode." :type 'string :group 'tcl) (defcustom tcl-command-switches nil - "*List of switches to supply to the `tcl-application' program." + "List of switches to supply to the `tcl-application' program." :type '(repeat string) :group 'tcl) (defcustom tcl-prompt-regexp "^\\(% \\|\\)" - "*If not nil, a regexp that will match the prompt in the inferior process. + "If not nil, a regexp that will match the prompt in the inferior process. If nil, the prompt is the name of the application with \">\" appended. The default is \"^\\(% \\|\\)\", which will match the default primary @@ -197,7 +197,7 @@ and secondary prompts for tclsh and wish." :group 'tcl) (defcustom inferior-tcl-source-command "source %s\n" - "*Format-string for building a Tcl command to load a file. + "Format-string for building a Tcl command to load a file. This format string should use `%s' to substitute a file name and should result in a Tcl expression that will command the inferior Tcl to load that file. The filename will be appropriately @@ -301,7 +301,7 @@ quoted for Tcl." ["Tcl help" tcl-help-on-word tcl-help-directory-list])) (defvar inferior-tcl-buffer nil - "*The current inferior-tcl process buffer. + "The current inferior-tcl process buffer. MULTIPLE PROCESS SUPPORT =========================================================================== diff --git a/lisp/progmodes/vera-mode.el b/lisp/progmodes/vera-mode.el index 7f3f99f5cfb..6737bf229a0 100644 --- a/lisp/progmodes/vera-mode.el +++ b/lisp/progmodes/vera-mode.el @@ -90,12 +90,12 @@ :group 'languages) (defcustom vera-basic-offset 2 - "*Amount of basic offset used for indentation." + "Amount of basic offset used for indentation." :type 'integer :group 'vera) (defcustom vera-underscore-is-part-of-word nil - "*Non-nil means consider the underscore character `_' as part of word. + "Non-nil means consider the underscore character `_' as part of word. An identifier containing underscores is then treated as a single word in select and move operations. All parts of an identifier separated by underscore are treated as single words otherwise." @@ -103,7 +103,7 @@ are treated as single words otherwise." :group 'vera) (defcustom vera-intelligent-tab t - "*Non-nil means `TAB' does indentation, word completion and tab insertion. + "Non-nil means `TAB' does indentation, word completion and tab insertion. That is, if preceding character is part of a word then complete word, else if not at beginning of line then insert tab, else if last command was a `TAB' or `RET' then dedent one step, diff --git a/lisp/progmodes/verilog-mode.el b/lisp/progmodes/verilog-mode.el index 73e3cd9980f..c8ef8f0324c 100644 --- a/lisp/progmodes/verilog-mode.el +++ b/lisp/progmodes/verilog-mode.el @@ -419,7 +419,7 @@ Set `verilog-in-hooks' during this time, to assist AUTO caches." (defcustom verilog-linter "echo 'No verilog-linter set, see \"M-x describe-variable verilog-linter\"'" - "*Unix program and arguments to call to run a lint checker on Verilog source. + "Unix program and arguments to call to run a lint checker on Verilog source. Depending on the `verilog-set-compile-command', this may be invoked when you type \\[compile]. When the compile completes, \\[next-error] will take you to the next lint error." @@ -429,7 +429,7 @@ you to the next lint error." (defcustom verilog-coverage "echo 'No verilog-coverage set, see \"M-x describe-variable verilog-coverage\"'" - "*Program and arguments to use to annotate for coverage Verilog source. + "Program and arguments to use to annotate for coverage Verilog source. Depending on the `verilog-set-compile-command', this may be invoked when you type \\[compile]. When the compile completes, \\[next-error] will take you to the next lint error." @@ -439,7 +439,7 @@ you to the next lint error." (defcustom verilog-simulator "echo 'No verilog-simulator set, see \"M-x describe-variable verilog-simulator\"'" - "*Program and arguments to use to interpret Verilog source. + "Program and arguments to use to interpret Verilog source. Depending on the `verilog-set-compile-command', this may be invoked when you type \\[compile]. When the compile completes, \\[next-error] will take you to the next lint error." @@ -449,7 +449,7 @@ you to the next lint error." (defcustom verilog-compiler "echo 'No verilog-compiler set, see \"M-x describe-variable verilog-compiler\"'" - "*Program and arguments to use to compile Verilog source. + "Program and arguments to use to compile Verilog source. Depending on the `verilog-set-compile-command', this may be invoked when you type \\[compile]. When the compile completes, \\[next-error] will take you to the next lint error." @@ -460,7 +460,7 @@ you to the next lint error." (defcustom verilog-preprocessor ;; Very few tools give preprocessed output, so we'll default to Verilog-Perl "vppreproc __FLAGS__ __FILE__" - "*Program and arguments to use to preprocess Verilog source. + "Program and arguments to use to preprocess Verilog source. This is invoked with `verilog-preprocess', and depending on the `verilog-set-compile-command', may also be invoked when you type \\[compile]. When the compile completes, \\[next-error] will @@ -480,7 +480,7 @@ Alternatively use the \"Choose Compilation Action\" menu. See `verilog-set-compile-command' for more information.") (defcustom verilog-highlight-translate-off nil - "*Non-nil means background-highlight code excluded from translation. + "Non-nil means background-highlight code excluded from translation. That is, all code between \"// synopsys translate_off\" and \"// synopsys translate_on\" is highlighted using a different background color \(face `verilog-font-lock-translate-off-face'). @@ -495,7 +495,7 @@ entry \"Fontify Buffer\"). XEmacs: turn off and on font locking." (put 'verilog-highlight-translate-off 'safe-local-variable 'verilog-booleanp) (defcustom verilog-auto-lineup 'declarations - "*Type of statements to lineup across multiple lines. + "Type of statements to lineup across multiple lines. If 'all' is selected, then all line ups described below are done. If 'declaration', then just declarations are lined up with any @@ -526,13 +526,13 @@ are lineup only when \\[verilog-pretty-declarations] is typed." :group 'verilog-mode-indent ) (defcustom verilog-indent-level 3 - "*Indentation of Verilog statements with respect to containing block." + "Indentation of Verilog statements with respect to containing block." :group 'verilog-mode-indent :type 'integer) (put 'verilog-indent-level 'safe-local-variable 'integerp) (defcustom verilog-indent-level-module 3 - "*Indentation of Module level Verilog statements (eg always, initial). + "Indentation of Module level Verilog statements (eg always, initial). Set to 0 to get initial and always statements lined up on the left side of your screen." :group 'verilog-mode-indent @@ -540,14 +540,14 @@ your screen." (put 'verilog-indent-level-module 'safe-local-variable 'integerp) (defcustom verilog-indent-level-declaration 3 - "*Indentation of declarations with respect to containing block. + "Indentation of declarations with respect to containing block. Set to 0 to get them list right under containing block." :group 'verilog-mode-indent :type 'integer) (put 'verilog-indent-level-declaration 'safe-local-variable 'integerp) (defcustom verilog-indent-declaration-macros nil - "*How to treat macro expansions in a declaration. + "How to treat macro expansions in a declaration. If nil, indent as: input [31:0] a; input `CP; @@ -561,7 +561,7 @@ If non nil, treat as: (put 'verilog-indent-declaration-macros 'safe-local-variable 'verilog-booleanp) (defcustom verilog-indent-lists t - "*How to treat indenting items in a list. + "How to treat indenting items in a list. If t (the default), indent as: always @( posedge a or reset ) begin @@ -574,58 +574,58 @@ If nil, treat as: (put 'verilog-indent-lists 'safe-local-variable 'verilog-booleanp) (defcustom verilog-indent-level-behavioral 3 - "*Absolute indentation of first begin in a task or function block. + "Absolute indentation of first begin in a task or function block. Set to 0 to get such code to start at the left side of the screen." :group 'verilog-mode-indent :type 'integer) (put 'verilog-indent-level-behavioral 'safe-local-variable 'integerp) (defcustom verilog-indent-level-directive 1 - "*Indentation to add to each level of `ifdef declarations. + "Indentation to add to each level of `ifdef declarations. Set to 0 to have all directives start at the left side of the screen." :group 'verilog-mode-indent :type 'integer) (put 'verilog-indent-level-directive 'safe-local-variable 'integerp) (defcustom verilog-cexp-indent 2 - "*Indentation of Verilog statements split across lines." + "Indentation of Verilog statements split across lines." :group 'verilog-mode-indent :type 'integer) (put 'verilog-cexp-indent 'safe-local-variable 'integerp) (defcustom verilog-case-indent 2 - "*Indentation for case statements." + "Indentation for case statements." :group 'verilog-mode-indent :type 'integer) (put 'verilog-case-indent 'safe-local-variable 'integerp) (defcustom verilog-auto-newline t - "*True means automatically newline after semicolons." + "True means automatically newline after semicolons." :group 'verilog-mode-indent :type 'boolean) (put 'verilog-auto-newline 'safe-local-variable 'verilog-booleanp) (defcustom verilog-auto-indent-on-newline t - "*True means automatically indent line after newline." + "True means automatically indent line after newline." :group 'verilog-mode-indent :type 'boolean) (put 'verilog-auto-indent-on-newline 'safe-local-variable 'verilog-booleanp) (defcustom verilog-tab-always-indent t - "*True means TAB should always re-indent the current line. + "True means TAB should always re-indent the current line. A nil value means TAB will only reindent when at the beginning of the line." :group 'verilog-mode-indent :type 'boolean) (put 'verilog-tab-always-indent 'safe-local-variable 'verilog-booleanp) (defcustom verilog-tab-to-comment nil - "*True means TAB moves to the right hand column in preparation for a comment." + "True means TAB moves to the right hand column in preparation for a comment." :group 'verilog-mode-actions :type 'boolean) (put 'verilog-tab-to-comment 'safe-local-variable 'verilog-booleanp) (defcustom verilog-indent-begin-after-if t - "*If true, indent begin statements following if, else, while, for and repeat. + "If true, indent begin statements following if, else, while, for and repeat. Otherwise, line them up." :group 'verilog-mode-indent :type 'boolean) @@ -633,14 +633,14 @@ Otherwise, line them up." (defcustom verilog-align-ifelse nil - "*If true, align `else' under matching `if'. + "If true, align `else' under matching `if'. Otherwise else is lined up with first character on line holding matching if." :group 'verilog-mode-indent :type 'boolean) (put 'verilog-align-ifelse 'safe-local-variable 'verilog-booleanp) (defcustom verilog-minimum-comment-distance 10 - "*Minimum distance (in lines) between begin and end required before a comment. + "Minimum distance (in lines) between begin and end required before a comment. Setting this variable to zero results in every end acquiring a comment; the default avoids too many redundant comments in tight quarters." :group 'verilog-mode-indent @@ -648,7 +648,7 @@ default avoids too many redundant comments in tight quarters." (put 'verilog-minimum-comment-distance 'safe-local-variable 'integerp) (defcustom verilog-highlight-p1800-keywords nil - "*True means highlight words newly reserved by IEEE-1800. + "True means highlight words newly reserved by IEEE-1800. These will appear in `verilog-font-lock-p1800-face' in order to gently suggest changing where these words are used as variables to something else. A nil value means highlight these words as appropriate for the SystemVerilog @@ -659,7 +659,7 @@ to see the effect as font color choices are cached by Emacs." (put 'verilog-highlight-p1800-keywords 'safe-local-variable 'verilog-booleanp) (defcustom verilog-highlight-grouping-keywords nil - "*True means highlight grouping keywords 'begin' and 'end' more dramatically. + "True means highlight grouping keywords 'begin' and 'end' more dramatically. If false, these words are in the `font-lock-type-face'; if True then they are in `verilog-font-lock-ams-face'. Some find that special highlighting on these grouping constructs allow the structure of the code to be understood at a glance." @@ -668,7 +668,7 @@ grouping constructs allow the structure of the code to be understood at a glance (put 'verilog-highlight-grouping-keywords 'safe-local-variable 'verilog-booleanp) (defcustom verilog-highlight-modules nil - "*True means highlight module statements for `verilog-load-file-at-point'. + "True means highlight module statements for `verilog-load-file-at-point'. When true, mousing over module names will allow jumping to the module definition. If false, this is not supported. Setting this is experimental, and may lead to bad performance." @@ -677,7 +677,7 @@ this is experimental, and may lead to bad performance." (put 'verilog-highlight-modules 'safe-local-variable 'verilog-booleanp) (defcustom verilog-highlight-includes t - "*True means highlight module statements for `verilog-load-file-at-point'. + "True means highlight module statements for `verilog-load-file-at-point'. When true, mousing over include file names will allow jumping to the file referenced. If false, this is not supported." :group 'verilog-mode-indent @@ -685,7 +685,7 @@ file referenced. If false, this is not supported." (put 'verilog-highlight-includes 'safe-local-variable 'verilog-booleanp) (defcustom verilog-auto-declare-nettype nil - "*Non-nil specifies the data type to use with `verilog-auto-input' etc. + "Non-nil specifies the data type to use with `verilog-auto-input' etc. Set this to \"wire\" if the Verilog code uses \"`default_nettype none\". Note using `default_nettype none isn't recommended practice; this mode is experimental." @@ -695,7 +695,7 @@ mode is experimental." (put 'verilog-auto-declare-nettype 'safe-local-variable `stringp) (defcustom verilog-auto-wire-type nil - "*Non-nil specifies the data type to use with `verilog-auto-wire' etc. + "Non-nil specifies the data type to use with `verilog-auto-wire' etc. Set this to \"logic\" for SystemVerilog code, or use `verilog-auto-logic'." :version "24.1" :group 'verilog-mode-actions @@ -703,21 +703,21 @@ Set this to \"logic\" for SystemVerilog code, or use `verilog-auto-logic'." (put 'verilog-auto-wire-type 'safe-local-variable `stringp) (defcustom verilog-auto-endcomments t - "*True means insert a comment /* ... */ after 'end's. + "True means insert a comment /* ... */ after 'end's. The name of the function or case will be set between the braces." :group 'verilog-mode-actions :type 'boolean) (put 'verilog-auto-endcomments 'safe-local-variable 'verilog-booleanp) (defcustom verilog-auto-delete-trailing-whitespace nil - "*True means to `delete-trailing-whitespace' in `verilog-auto'." + "True means to `delete-trailing-whitespace' in `verilog-auto'." :version "24.1" :group 'verilog-mode-actions :type 'boolean) (put 'verilog-auto-delete-trailing-whitespace 'safe-local-variable 'verilog-booleanp) (defcustom verilog-auto-ignore-concat nil - "*True means ignore signals in {...} concatenations for AUTOWIRE etc. + "True means ignore signals in {...} concatenations for AUTOWIRE etc. This will exclude signals referenced as pin connections in {...} from AUTOWIRE, AUTOOUTPUT and friends. This flag should be set for backward compatibility only and not set in new designs; it @@ -727,7 +727,7 @@ may be removed in future versions." (put 'verilog-auto-ignore-concat 'safe-local-variable 'verilog-booleanp) (defcustom verilog-auto-read-includes nil - "*True means to automatically read includes before AUTOs. + "True means to automatically read includes before AUTOs. This will do a `verilog-read-defines' and `verilog-read-includes' before each AUTO expansion. This makes it easier to embed defines and includes, but can result in very slow reading times if there are many or large @@ -737,7 +737,7 @@ include files." (put 'verilog-auto-read-includes 'safe-local-variable 'verilog-booleanp) (defcustom verilog-auto-save-policy nil - "*Non-nil indicates action to take when saving a Verilog buffer with AUTOs. + "Non-nil indicates action to take when saving a Verilog buffer with AUTOs. A value of `force' will always do a \\[verilog-auto] automatically if needed on every save. A value of `detect' will do \\[verilog-auto] automatically when it thinks necessary. A value of `ask' will query the @@ -750,7 +750,7 @@ sub-module's port list has changed." :type '(choice (const nil) (const ask) (const detect) (const force))) (defcustom verilog-auto-star-expand t - "*Non-nil indicates to expand a SystemVerilog .* instance ports. + "Non-nil indicates to expand a SystemVerilog .* instance ports. They will be expanded in the same way as if there was a AUTOINST in the instantiation. See also `verilog-auto-star' and `verilog-auto-star-save'." :group 'verilog-mode-actions @@ -758,7 +758,7 @@ instantiation. See also `verilog-auto-star' and `verilog-auto-star-save'." (put 'verilog-auto-star-expand 'safe-local-variable 'verilog-booleanp) (defcustom verilog-auto-star-save nil - "*Non-nil indicates to save to disk SystemVerilog .* instance expansions. + "Non-nil indicates to save to disk SystemVerilog .* instance expansions. A nil value indicates direct connections will be removed before saving. Only meaningful to those created due to `verilog-auto-star-expand' being set. @@ -775,7 +775,7 @@ always be saved." "Text from file-local-variables during last evaluation.") (defvar verilog-diff-function 'verilog-diff-report - "*Function to run when `verilog-diff-auto' detects differences. + "Function to run when `verilog-diff-auto' detects differences. Function takes three arguments, the original buffer, the difference buffer, and the point in original buffer with the first difference.") @@ -869,11 +869,11 @@ See `compilation-error-regexp-alist-alist' for the formatting. For XEmacs.") ("^In file \\([^ \t]+\\)[ \t]+line[ \t]+\\([0-9]+\\):\n[^\n]*\n[^\n]*\n\\(Warning\\|Error\\|Failure\\)[^\n]*" 1 bold t) ("^In file \\([^ \t]+\\)[ \t]+line[ \t]+\\([0-9]+\\):\n[^\n]*\n[^\n]*\n\\(Warning\\|Error\\|Failure\\)[^\n]*" 2 bold t) ) - "*Keywords to also highlight in Verilog *compilation* buffers. + "Keywords to also highlight in Verilog *compilation* buffers. Only used in XEmacs; GNU Emacs uses `verilog-error-regexp-emacs-alist'.") (defcustom verilog-library-flags '("") - "*List of standard Verilog arguments to use for /*AUTOINST*/. + "List of standard Verilog arguments to use for /*AUTOINST*/. These arguments are used to find files for `verilog-auto', and match the flags accepted by a standard Verilog-XL simulator. @@ -904,7 +904,7 @@ See also the variables mentioned above." (put 'verilog-library-flags 'safe-local-variable 'listp) (defcustom verilog-library-directories '(".") - "*List of directories when looking for files for /*AUTOINST*/. + "List of directories when looking for files for /*AUTOINST*/. The directory may be relative to the current file, or absolute. Environment variables are also expanded in the directory names. Having at least the current directory is a good idea. @@ -927,7 +927,7 @@ and `verilog-library-extensions'." (put 'verilog-library-directories 'safe-local-variable 'listp) (defcustom verilog-library-files '() - "*List of files to search for modules. + "List of files to search for modules. AUTOINST will use this when it needs to resolve a module name. This is a complete path, usually to a technology file with many standard cells defined in it. @@ -949,14 +949,14 @@ See also `verilog-library-flags', `verilog-library-directories'." (put 'verilog-library-files 'safe-local-variable 'listp) (defcustom verilog-library-extensions '(".v" ".sv") - "*List of extensions to use when looking for files for /*AUTOINST*/. + "List of extensions to use when looking for files for /*AUTOINST*/. See also `verilog-library-flags', `verilog-library-directories'." :type '(repeat string) :group 'verilog-mode-auto) (put 'verilog-library-extensions 'safe-local-variable 'listp) (defcustom verilog-active-low-regexp nil - "*If set, treat signals matching this regexp as active low. + "If set, treat signals matching this regexp as active low. This is used for AUTORESET and AUTOTIEOFF. For proper behavior, you will probably also need `verilog-auto-reset-widths' set." :group 'verilog-mode-auto @@ -964,7 +964,7 @@ you will probably also need `verilog-auto-reset-widths' set." (put 'verilog-active-low-regexp 'safe-local-variable 'stringp) (defcustom verilog-auto-sense-include-inputs nil - "*If true, AUTOSENSE should include all inputs. + "If true, AUTOSENSE should include all inputs. If nil, only inputs that are NOT output signals in the same block are included." :group 'verilog-mode-auto @@ -972,7 +972,7 @@ included." (put 'verilog-auto-sense-include-inputs 'safe-local-variable 'verilog-booleanp) (defcustom verilog-auto-sense-defines-constant nil - "*If true, AUTOSENSE should assume all defines represent constants. + "If true, AUTOSENSE should assume all defines represent constants. When true, the defines will not be included in sensitivity lists. To maintain compatibility with other sites, this should be set at the bottom of each Verilog file that requires it, rather than being set globally." @@ -981,7 +981,7 @@ of each Verilog file that requires it, rather than being set globally." (put 'verilog-auto-sense-defines-constant 'safe-local-variable 'verilog-booleanp) (defcustom verilog-auto-reset-blocking-in-non t - "*If true, AUTORESET will reset those signals which were + "If true, AUTORESET will reset those signals which were assigned with blocking assignments (=) even in a block with non-blocking assignments (<=). @@ -995,7 +995,7 @@ those temporaries reset. See example in `verilog-auto-reset'." (put 'verilog-auto-reset-blocking-in-non 'safe-local-variable 'verilog-booleanp) (defcustom verilog-auto-reset-widths t - "*If true, AUTORESET should determine the width of signals. + "If true, AUTORESET should determine the width of signals. This is then used to set the width of the zero (32'h0 for example). This is required by some lint tools that aren't smart enough to ignore widths of the constant zero. This may result in ugly code when parameters determine @@ -1005,13 +1005,13 @@ the MSB or LSB of a signal inside an AUTORESET." (put 'verilog-auto-reset-widths 'safe-local-variable 'verilog-booleanp) (defcustom verilog-assignment-delay "" - "*Text used for delays in delayed assignments. Add a trailing space if set." + "Text used for delays in delayed assignments. Add a trailing space if set." :group 'verilog-mode-auto :type 'string) (put 'verilog-assignment-delay 'safe-local-variable 'stringp) (defcustom verilog-auto-arg-sort nil - "*If set, AUTOARG signal names will be sorted, not in declaration order. + "If set, AUTOARG signal names will be sorted, not in declaration order. Declaration order is advantageous with order based instantiations and is the default for backward compatibility. Sorted order reduces changes when declarations are moved around in a file, and @@ -1023,7 +1023,7 @@ See also `verilog-auto-inst-sort'." (put 'verilog-auto-arg-sort 'safe-local-variable 'verilog-booleanp) (defcustom verilog-auto-inst-dot-name nil - "*If true, when creating ports with AUTOINST, use .name syntax. + "If true, when creating ports with AUTOINST, use .name syntax. This will use \".port\" instead of \".port(port)\" when possible. This is only legal in SystemVerilog files, and will confuse older simulators. Setting `verilog-auto-inst-vector' to nil may also @@ -1033,7 +1033,7 @@ be desirable to increase how often .name will be used." (put 'verilog-auto-inst-dot-name 'safe-local-variable 'verilog-booleanp) (defcustom verilog-auto-inst-param-value nil - "*If set, AUTOINST will replace parameters with the parameter value. + "If set, AUTOINST will replace parameters with the parameter value. If nil, leave parameters as symbolic names. Parameters must be in Verilog 2001 format #(...), and if a parameter is not @@ -1070,7 +1070,7 @@ instead expand to: (put 'verilog-auto-inst-param-value 'safe-local-variable 'verilog-booleanp) (defcustom verilog-auto-inst-sort nil - "*If set, AUTOINST signal names will be sorted, not in declaration order. + "If set, AUTOINST signal names will be sorted, not in declaration order. Also affects AUTOINSTPARAM. Declaration order is the default for backward compatibility, and as some teams prefer signals that are declared together to remain together. Sorted order reduces @@ -1083,7 +1083,7 @@ See also `verilog-auto-arg-sort'." (put 'verilog-auto-inst-sort 'safe-local-variable 'verilog-booleanp) (defcustom verilog-auto-inst-vector t - "*If true, when creating default ports with AUTOINST, use bus subscripts. + "If true, when creating default ports with AUTOINST, use bus subscripts. If nil, skip the subscript when it matches the entire bus as declared in the module (AUTOWIRE signals always are subscripted, you must manually declare the wire to have the subscripts removed.) Setting this to nil may @@ -1093,7 +1093,7 @@ speed up some simulators, but is less general and harder to read, so avoid." (put 'verilog-auto-inst-vector 'safe-local-variable 'verilog-booleanp) (defcustom verilog-auto-inst-template-numbers nil - "*If true, when creating templated ports with AUTOINST, add a comment. + "If true, when creating templated ports with AUTOINST, add a comment. If t, the comment will add the line number of the template that was used for that port declaration. This setting is suggested @@ -1110,34 +1110,34 @@ won't merge conflict." '(lambda (x) (memq x '(nil t lhs)))) (defcustom verilog-auto-inst-column 40 - "*Indent-to column number for net name part of AUTOINST created pin." + "Indent-to column number for net name part of AUTOINST created pin." :group 'verilog-mode-indent :type 'integer) (put 'verilog-auto-inst-column 'safe-local-variable 'integerp) (defcustom verilog-auto-input-ignore-regexp nil - "*If set, when creating AUTOINPUT list, ignore signals matching this regexp. + "If set, when creating AUTOINPUT list, ignore signals matching this regexp. See the \\[verilog-faq] for examples on using this." :group 'verilog-mode-auto :type 'string) (put 'verilog-auto-input-ignore-regexp 'safe-local-variable 'stringp) (defcustom verilog-auto-inout-ignore-regexp nil - "*If set, when creating AUTOINOUT list, ignore signals matching this regexp. + "If set, when creating AUTOINOUT list, ignore signals matching this regexp. See the \\[verilog-faq] for examples on using this." :group 'verilog-mode-auto :type 'string) (put 'verilog-auto-inout-ignore-regexp 'safe-local-variable 'stringp) (defcustom verilog-auto-output-ignore-regexp nil - "*If set, when creating AUTOOUTPUT list, ignore signals matching this regexp. + "If set, when creating AUTOOUTPUT list, ignore signals matching this regexp. See the \\[verilog-faq] for examples on using this." :group 'verilog-mode-auto :type 'string) (put 'verilog-auto-output-ignore-regexp 'safe-local-variable 'stringp) (defcustom verilog-auto-tieoff-declaration "wire" - "*Data type used for the declaration for AUTOTIEOFF. If \"wire\" then + "Data type used for the declaration for AUTOTIEOFF. If \"wire\" then create a wire, if \"assign\" create an assignment, else the data type for variable creation." :version "24.1" @@ -1146,58 +1146,58 @@ variable creation." (put 'verilog-auto-tieoff-declaration 'safe-local-variable 'stringp) (defcustom verilog-auto-tieoff-ignore-regexp nil - "*If set, when creating AUTOTIEOFF list, ignore signals matching this regexp. + "If set, when creating AUTOTIEOFF list, ignore signals matching this regexp. See the \\[verilog-faq] for examples on using this." :group 'verilog-mode-auto :type 'string) (put 'verilog-auto-tieoff-ignore-regexp 'safe-local-variable 'stringp) (defcustom verilog-auto-unused-ignore-regexp nil - "*If set, when creating AUTOUNUSED list, ignore signals matching this regexp. + "If set, when creating AUTOUNUSED list, ignore signals matching this regexp. See the \\[verilog-faq] for examples on using this." :group 'verilog-mode-auto :type 'string) (put 'verilog-auto-unused-ignore-regexp 'safe-local-variable 'stringp) (defcustom verilog-typedef-regexp nil - "*If non-nil, regular expression that matches Verilog-2001 typedef names. + "If non-nil, regular expression that matches Verilog-2001 typedef names. For example, \"_t$\" matches typedefs named with _t, as in the C language." :group 'verilog-mode-auto :type 'string) (put 'verilog-typedef-regexp 'safe-local-variable 'stringp) (defcustom verilog-mode-hook 'verilog-set-compile-command - "*Hook run after Verilog mode is loaded." + "Hook run after Verilog mode is loaded." :type 'hook :group 'verilog-mode) (defcustom verilog-auto-hook nil - "*Hook run after `verilog-mode' updates AUTOs." + "Hook run after `verilog-mode' updates AUTOs." :group 'verilog-mode-auto :type 'hook) (defcustom verilog-before-auto-hook nil - "*Hook run before `verilog-mode' updates AUTOs." + "Hook run before `verilog-mode' updates AUTOs." :group 'verilog-mode-auto :type 'hook) (defcustom verilog-delete-auto-hook nil - "*Hook run after `verilog-mode' deletes AUTOs." + "Hook run after `verilog-mode' deletes AUTOs." :group 'verilog-mode-auto :type 'hook) (defcustom verilog-before-delete-auto-hook nil - "*Hook run before `verilog-mode' deletes AUTOs." + "Hook run before `verilog-mode' deletes AUTOs." :group 'verilog-mode-auto :type 'hook) (defcustom verilog-getopt-flags-hook nil - "*Hook run after `verilog-getopt-flags' determines the Verilog option lists." + "Hook run after `verilog-getopt-flags' determines the Verilog option lists." :group 'verilog-mode-auto :type 'hook) (defcustom verilog-before-getopt-flags-hook nil - "*Hook run before `verilog-getopt-flags' determines the Verilog option lists." + "Hook run before `verilog-getopt-flags' determines the Verilog option lists." :group 'verilog-mode-auto :type 'hook) @@ -1211,17 +1211,17 @@ For example, \"_t$\" matches typedefs named with _t, as in the C language." ;; Customization variables: ;; (defvar verilog-date-scientific-format nil - "*If non-nil, dates are written in scientific format (e.g. 1997/09/17). + "If non-nil, dates are written in scientific format (e.g. 1997/09/17). If nil, in European format (e.g. 17.09.1997). The brain-dead American format (e.g. 09/17/1997) is not supported.") (defvar verilog-company nil - "*Default name of Company for Verilog header. + "Default name of Company for Verilog header. If set will become buffer local.") (make-variable-buffer-local 'verilog-company) (defvar verilog-project nil - "*Default name of Project for Verilog header. + "Default name of Project for Verilog header. If set will become buffer local.") (make-variable-buffer-local 'verilog-project) @@ -6686,7 +6686,7 @@ Region is defined by B and EDPOS." (defvar verilog-buffer-to-use nil) (defvar verilog-flag nil) (defvar verilog-toggle-completions nil - "*True means \\<verilog-mode-map>\\[verilog-complete-word] should try all possible completions one by one. + "True means \\<verilog-mode-map>\\[verilog-complete-word] should try all possible completions one by one. Repeated use of \\[verilog-complete-word] will show you all of them. Normally, when there is more than one possible completion, it displays a list of all possible completions.") @@ -6701,13 +6701,13 @@ it displays a list of all possible completions.") "rtranif1" "semaphore" "time" "tran" "tranif0" "tranif1" "tri" "tri0" "tri1" "triand" "trior" "trireg" "wand" "wire" "wor" "xnor" "xor" ) - "*Keywords for types used when completing a word in a declaration or parmlist. + "Keywords for types used when completing a word in a declaration or parmlist. \(integer, real, reg...)") (defvar verilog-cpp-keywords '("module" "macromodule" "primitive" "timescale" "define" "ifdef" "ifndef" "else" "endif") - "*Keywords to complete when at first word of a line in declarative scope. + "Keywords to complete when at first word of a line in declarative scope. \(initial, always, begin, assign...) The procedures and variables defined within the Verilog program will be completed at runtime and should not be added to this list.") @@ -6721,7 +6721,7 @@ will be completed at runtime and should not be added to this list.") "task" "endtask" "primitive" "endprimitive" ) verilog-type-keywords) - "*Keywords to complete when at first word of a line in declarative scope. + "Keywords to complete when at first word of a line in declarative scope. \(initial, always, begin, assign...) The procedures and variables defined within the Verilog program will be completed at runtime and should not be added to this list.") @@ -6732,28 +6732,28 @@ will be completed at runtime and should not be added to this list.") "endgenerate" "endinterface" "endpackage" "endspecify" "endtask" "for" "fork" "if" "join" "join_any" "join_none" "repeat" "return" "while") - "*Keywords to complete when at first word of a line in behavioral scope. + "Keywords to complete when at first word of a line in behavioral scope. \(begin, if, then, else, for, fork...) The procedures and variables defined within the Verilog program will be completed at runtime and should not be added to this list.") (defvar verilog-tf-keywords '("begin" "break" "fork" "join" "join_any" "join_none" "case" "end" "endtask" "endfunction" "if" "else" "for" "while" "repeat") - "*Keywords to complete when at first word of a line in a task or function. + "Keywords to complete when at first word of a line in a task or function. \(begin, if, then, else, for, fork.) The procedures and variables defined within the Verilog program will be completed at runtime and should not be added to this list.") (defvar verilog-case-keywords '("begin" "fork" "join" "join_any" "join_none" "case" "end" "endcase" "if" "else" "for" "repeat") - "*Keywords to complete when at first word of a line in case scope. + "Keywords to complete when at first word of a line in case scope. \(begin, if, then, else, for, fork...) The procedures and variables defined within the Verilog program will be completed at runtime and should not be added to this list.") (defvar verilog-separator-keywords '("else" "then" "begin") - "*Keywords to complete when NOT standing at the first word of a statement. + "Keywords to complete when NOT standing at the first word of a statement. \(else, then, begin...) Variables and function names defined within the Verilog program will be completed at runtime and should not be added to this list.") @@ -6786,10 +6786,10 @@ will be completed at runtime and should not be added to this list.") ("tranif1" "inout" "inout") ("xnor" "output") ("xor" "output")) - "*Map of direction for each positional argument to each gate primitive.") + "Map of direction for each positional argument to each gate primitive.") (defvar verilog-gate-keywords (mapcar `car verilog-gate-ios) - "*Keywords for gate primitives.") + "Keywords for gate primitives.") (defun verilog-string-diff (str1 str2) "Return index of first letter where STR1 and STR2 differs." diff --git a/lisp/progmodes/vhdl-mode.el b/lisp/progmodes/vhdl-mode.el index c9bf638bb59..9b7ee5d6aa0 100644 --- a/lisp/progmodes/vhdl-mode.el +++ b/lisp/progmodes/vhdl-mode.el @@ -198,7 +198,7 @@ Examples: :group 'vhdl) (defcustom vhdl-indent-tabs-mode nil - "*Non-nil means indentation can insert tabs. + "Non-nil means indentation can insert tabs. Overrides local variable `indent-tabs-mode'." :type 'boolean :group 'vhdl-mode) @@ -322,7 +322,7 @@ Overrides local variable `indent-tabs-mode'." ("^ *Compiling \"\\(.+\\)\" " 1) nil) ) - "*List of available VHDL compilers and their properties. + "List of available VHDL compilers and their properties. Each list entry specifies the following items for a compiler: Compiler: Compiler name : name used in option `vhdl-compiler' to choose compiler @@ -429,7 +429,7 @@ NOTE: Activate new error and file message regexps and reflect the new setting :group 'vhdl-compile) (defcustom vhdl-compiler "ModelSim" - "*Specifies the VHDL compiler to be used for syntax analysis. + "Specifies the VHDL compiler to be used for syntax analysis. Select a compiler name from the ones defined in option `vhdl-compiler-alist'." :type (let ((alist vhdl-compiler-alist) list) (while alist @@ -439,7 +439,7 @@ Select a compiler name from the ones defined in option `vhdl-compiler-alist'." :group 'vhdl-compile) (defcustom vhdl-compile-use-local-error-regexp t - "*Non-nil means use buffer-local `compilation-error-regexp-alist'. + "Non-nil means use buffer-local `compilation-error-regexp-alist'. In this case, only error message regexps for VHDL compilers are active if compilation is started from a VHDL buffer. Otherwise, the error message regexps are appended to the predefined global regexps, and all regexps are @@ -451,7 +451,7 @@ NOTE: Activate the new setting by restarting Emacs." :group 'vhdl-compile) (defcustom vhdl-makefile-generation-hook nil - "*Functions to run at the end of Makefile generation. + "Functions to run at the end of Makefile generation. Allows to insert user specific parts into a Makefile. Example: @@ -462,7 +462,7 @@ Example: :group 'vhdl-compile) (defcustom vhdl-default-library "work" - "*Name of default library. + "Name of default library. Is overwritten by project settings if a project is active." :type 'string :group 'vhdl-compile) @@ -488,7 +488,7 @@ Is overwritten by project settings if a project is active." -- This is a multi-line project description -- that can be used as a project dependent part of the file header. ")) - "*List of projects and their properties. + "List of projects and their properties. Name : name used in option `vhdl-project' to choose project Title : title of project (single-line string) Default directory: default project directory (absolute path) @@ -594,7 +594,7 @@ NOTE: Reflect the new setting in the choice list of option `vhdl-project' :group 'vhdl-project) (defcustom vhdl-project nil - "*Specifies the default for the current project. + "Specifies the default for the current project. Select a project name from the ones defined in option `vhdl-project-alist'. Is used to determine the project title and description to be inserted in file headers and the source files/directories to be scanned in the hierarchy @@ -608,7 +608,7 @@ browser. The current project can also be changed temporarily in the menu." :group 'vhdl-project) (defcustom vhdl-project-file-name '("\\1.prj") - "*List of file names/paths for importing/exporting project setups. + "List of file names/paths for importing/exporting project setups. \"\\1\" is replaced by the project name (SPC is replaced by `_'), \"\\2\" is replaced by the user name (allows to have user-specific project setups). The first entry is used as file name to import/export individual project @@ -624,7 +624,7 @@ in global directories)." :group 'vhdl-project) (defcustom vhdl-project-auto-load '(startup) - "*Automatically load project setups from files. + "Automatically load project setups from files. All project setup files that match the file names specified in option `vhdl-project-file-name' are automatically loaded. The project of the \(alphabetically) last loaded setup of the first `vhdl-project-file-name' @@ -635,7 +635,7 @@ A project setup file can be obtained by exporting a project (see menu). :group 'vhdl-project) (defcustom vhdl-project-sort t - "*Non-nil means projects are displayed in alphabetical order." + "Non-nil means projects are displayed in alphabetical order." :type 'boolean :group 'vhdl-project) @@ -648,7 +648,7 @@ A project setup file can be obtained by exporting a project (see menu). :group 'vhdl-compose) (defcustom vhdl-standard '(87 nil) - "*VHDL standards used. + "VHDL standards used. Basic standard: VHDL'87 : IEEE Std 1076-1987 VHDL'93 : IEEE Std 1076-1993 @@ -675,13 +675,13 @@ NOTE: Activate the new setting in a VHDL buffer by using the menu entry :group 'vhdl-style) (defcustom vhdl-basic-offset 2 - "*Amount of basic offset used for indentation. + "Amount of basic offset used for indentation. This value is used by + and - symbols in `vhdl-offsets-alist'." :type 'integer :group 'vhdl-style) (defcustom vhdl-upper-case-keywords nil - "*Non-nil means convert keywords to upper case. + "Non-nil means convert keywords to upper case. This is done when typed or expanded or by the fix case functions." :type 'boolean :set (lambda (variable value) @@ -689,7 +689,7 @@ This is done when typed or expanded or by the fix case functions." :group 'vhdl-style) (defcustom vhdl-upper-case-types nil - "*Non-nil means convert standardized types to upper case. + "Non-nil means convert standardized types to upper case. This is done when expanded or by the fix case functions." :type 'boolean :set (lambda (variable value) @@ -697,7 +697,7 @@ This is done when expanded or by the fix case functions." :group 'vhdl-style) (defcustom vhdl-upper-case-attributes nil - "*Non-nil means convert standardized attributes to upper case. + "Non-nil means convert standardized attributes to upper case. This is done when expanded or by the fix case functions." :type 'boolean :set (lambda (variable value) @@ -705,7 +705,7 @@ This is done when expanded or by the fix case functions." :group 'vhdl-style) (defcustom vhdl-upper-case-enum-values nil - "*Non-nil means convert standardized enumeration values to upper case. + "Non-nil means convert standardized enumeration values to upper case. This is done when expanded or by the fix case functions." :type 'boolean :set (lambda (variable value) @@ -713,7 +713,7 @@ This is done when expanded or by the fix case functions." :group 'vhdl-style) (defcustom vhdl-upper-case-constants t - "*Non-nil means convert standardized constants to upper case. + "Non-nil means convert standardized constants to upper case. This is done when expanded." :type 'boolean :set (lambda (variable value) @@ -721,7 +721,7 @@ This is done when expanded." :group 'vhdl-style) (defcustom vhdl-use-direct-instantiation 'standard - "*Non-nil means use VHDL'93 direct component instantiation. + "Non-nil means use VHDL'93 direct component instantiation. Never : never Standard: only in VHDL standards that allow it (VHDL'93 and higher) Always : always" @@ -737,7 +737,7 @@ This is done when expanded." (defcustom vhdl-entity-file-name '(".*" . "\\&") (concat - "*Specifies how the entity file name is obtained. + "Specifies how the entity file name is obtained. The entity file name can be obtained by modifying the entity name (e.g. attaching or stripping off a substring). The file extension is automatically taken from the file name of the current buffer." @@ -749,7 +749,7 @@ taken from the file name of the current buffer." (defcustom vhdl-architecture-file-name '("\\(.*\\) \\(.*\\)" . "\\1_\\2") (concat - "*Specifies how the architecture file name is obtained. + "Specifies how the architecture file name is obtained. The architecture file name can be obtained by modifying the entity and/or architecture name (e.g. attaching or stripping off a substring). The file extension is automatically taken from the file name of the current @@ -764,7 +764,7 @@ access to both names (see default setting as example)." (defcustom vhdl-configuration-file-name '(".*" . "\\&") (concat - "*Specifies how the configuration file name is obtained. + "Specifies how the configuration file name is obtained. The configuration file name can be obtained by modifying the configuration name (e.g. attaching or stripping off a substring). The file extension is automatically taken from the file name of the current buffer." @@ -776,7 +776,7 @@ automatically taken from the file name of the current buffer." (defcustom vhdl-package-file-name '(".*" . "\\&") (concat - "*Specifies how the package file name is obtained. + "Specifies how the package file name is obtained. The package file name can be obtained by modifying the package name (e.g. attaching or stripping off a substring). The file extension is automatically taken from the file name of the current buffer. Package files can be created @@ -789,7 +789,7 @@ file name." :group 'vhdl-compose) (defcustom vhdl-file-name-case 'identity - "*Specifies how to change case for obtaining file names. + "Specifies how to change case for obtaining file names. When deriving a file name from a VHDL unit name, case can be changed as follows: As Is: case is not changed (taken as is) @@ -809,7 +809,7 @@ follows: :group 'vhdl) (defcustom vhdl-electric-keywords '(vhdl user) - "*Type of keywords for which electrification is enabled. + "Type of keywords for which electrification is enabled. VHDL keywords: invoke built-in templates User keywords: invoke user models (see option `vhdl-model-alist')" :type '(set (const :tag "VHDL keywords" vhdl) @@ -819,7 +819,7 @@ follows: :group 'vhdl-template) (defcustom vhdl-optional-labels 'process - "*Constructs for which labels are to be queried. + "Constructs for which labels are to be queried. Template generators prompt for optional labels for: None : no constructs Processes only: processes only (also procedurals in VHDL-AMS) @@ -830,7 +830,7 @@ Template generators prompt for optional labels for: :group 'vhdl-template) (defcustom vhdl-insert-empty-lines 'unit - "*Specifies whether to insert empty lines in some templates. + "Specifies whether to insert empty lines in some templates. This improves readability of code. Empty lines are inserted in: None : no constructs Design units only: entities, architectures, configurations, packages only @@ -845,7 +845,7 @@ Replaces option `vhdl-additional-empty-lines'." :group 'vhdl-compose) (defcustom vhdl-argument-list-indent nil - "*Non-nil means indent argument lists relative to opening parenthesis. + "Non-nil means indent argument lists relative to opening parenthesis. That is, argument, association, and port lists start on the same line as the opening parenthesis and subsequent lines are indented accordingly. Otherwise, lists start on a new line and are indented as normal code." @@ -855,7 +855,7 @@ Otherwise, lists start on a new line and are indented as normal code." :group 'vhdl-compose) (defcustom vhdl-association-list-with-formals t - "*Non-nil means write association lists with formal parameters. + "Non-nil means write association lists with formal parameters. Templates prompt for formal and actual parameters (ports/generics). When pasting component instantiations, formals are included. If nil, only a list of actual parameters is entered." @@ -865,17 +865,17 @@ If nil, only a list of actual parameters is entered." :group 'vhdl-compose) (defcustom vhdl-conditions-in-parenthesis nil - "*Non-nil means place parenthesis around condition expressions." + "Non-nil means place parenthesis around condition expressions." :type 'boolean :group 'vhdl-template) (defcustom vhdl-zero-string "'0'" - "*String to use for a logic zero." + "String to use for a logic zero." :type 'string :group 'vhdl-template) (defcustom vhdl-one-string "'1'" - "*String to use for a logic one." + "String to use for a logic one." :type 'string :group 'vhdl-template) @@ -906,7 +906,7 @@ If nil, only a list of actual parameters is entered." ------------------------------------------------------------------------------- " - "*String or file to insert as file header. + "String or file to insert as file header. If the string specifies an existing file name, the contents of the file is inserted, otherwise the string itself is inserted as file header. Type `C-j' for newlines. @@ -936,7 +936,7 @@ dependent part of the file header and can also contain the above keywords." :group 'vhdl-header) (defcustom vhdl-file-footer "" - "*String or file to insert as file footer. + "String or file to insert as file footer. If the string specifies an existing file name, the contents of the file is inserted, otherwise the string itself is inserted as file footer (i.e. at the end of the file). @@ -946,7 +946,7 @@ The same keywords as in option `vhdl-file-header' can be used." :group 'vhdl-header) (defcustom vhdl-company-name "" - "*Name of company to insert in file header. + "Name of company to insert in file header. See option `vhdl-file-header'." :type 'string :group 'vhdl-header) @@ -955,14 +955,14 @@ See option `vhdl-file-header'." ------------------------------------------------------------------------------- -- Copyright (c) <year> <company> " - "*Copyright string to insert in file header. + "Copyright string to insert in file header. Can be multi-line string (type `C-j' for newline) and contain other file header keywords (see option `vhdl-file-header')." :type 'string :group 'vhdl-header) (defcustom vhdl-platform-spec "" - "*Specification of VHDL platform to insert in file header. + "Specification of VHDL platform to insert in file header. The platform specification should contain names and versions of the simulation and synthesis tools used. See option `vhdl-file-header'." @@ -970,7 +970,7 @@ See option `vhdl-file-header'." :group 'vhdl-header) (defcustom vhdl-date-format "%Y-%m-%d" - "*Specifies the date format to use in the header. + "Specifies the date format to use in the header. This string is passed as argument to the command `format-time-string'. For more information on format strings, see the documentation for the `format-time-string' command (C-h f `format-time-string')." @@ -978,7 +978,7 @@ For more information on format strings, see the documentation for the :group 'vhdl-header) (defcustom vhdl-modify-date-prefix-string "-- Last update: " - "*Prefix string of modification date in VHDL file header. + "Prefix string of modification date in VHDL file header. If actualization of the modification date is called (menu, `\\[vhdl-template-modify]'), this string is searched and the rest of the line replaced by the current date." @@ -986,7 +986,7 @@ of the line replaced by the current date." :group 'vhdl-header) (defcustom vhdl-modify-date-on-saving t - "*Non-nil means update the modification date when the buffer is saved. + "Non-nil means update the modification date when the buffer is saved. Calls function `\\[vhdl-template-modify]'). NOTE: Activate the new setting in a VHDL buffer by using the menu entry @@ -1000,26 +1000,26 @@ NOTE: Activate the new setting in a VHDL buffer by using the menu entry :group 'vhdl-template) (defcustom vhdl-reset-kind 'async - "*Specifies which kind of reset to use in sequential processes." + "Specifies which kind of reset to use in sequential processes." :type '(choice (const :tag "None" none) (const :tag "Synchronous" sync) (const :tag "Asynchronous" async)) :group 'vhdl-sequential-process) (defcustom vhdl-reset-active-high nil - "*Non-nil means reset in sequential processes is active high. + "Non-nil means reset in sequential processes is active high. Otherwise, reset is active low." :type 'boolean :group 'vhdl-sequential-process) (defcustom vhdl-clock-rising-edge t - "*Non-nil means rising edge of clock triggers sequential processes. + "Non-nil means rising edge of clock triggers sequential processes. Otherwise, falling edge triggers." :type 'boolean :group 'vhdl-sequential-process) (defcustom vhdl-clock-edge-condition 'standard - "*Syntax of the clock edge condition. + "Syntax of the clock edge condition. Standard: \"clk'event and clk = '1'\" Function: \"rising_edge(clk)\"" :type '(choice (const :tag "Standard" standard) @@ -1027,12 +1027,12 @@ Otherwise, falling edge triggers." :group 'vhdl-sequential-process) (defcustom vhdl-clock-name "" - "*Name of clock signal to use in templates." + "Name of clock signal to use in templates." :type 'string :group 'vhdl-sequential-process) (defcustom vhdl-reset-name "" - "*Name of reset signal to use in templates." + "Name of reset signal to use in templates." :type 'string :group 'vhdl-sequential-process) @@ -1054,7 +1054,7 @@ begin -- process <label> end if; end process <label>;" "e" "")) - "*List of user models. + "List of user models. VHDL models (templates) can be specified by the user in this list. They can be invoked from the menu, through key bindings (`C-c C-m ...'), or by keyword electrification (i.e. overriding existing or creating new keywords, see @@ -1103,7 +1103,7 @@ NOTE: Activate the new setting in a VHDL buffer by using the menu entry (defcustom vhdl-compose-architecture-name '(".*" . "str") (concat - "*Specifies how the component architecture name is obtained. + "Specifies how the component architecture name is obtained. The component architecture name can be obtained by modifying the entity name \(e.g. attaching or stripping off a substring). If TO STRING is empty, the architecture name is queried." @@ -1115,7 +1115,7 @@ If TO STRING is empty, the architecture name is queried." (defcustom vhdl-compose-configuration-name '("\\(.*\\) \\(.*\\)" . "\\1_\\2_cfg") (concat - "*Specifies how the configuration name is obtained. + "Specifies how the configuration name is obtained. The configuration name can be obtained by modifying the entity and/or architecture name (e.g. attaching or stripping off a substring). The string that is matched against the regexp is the concatenation of the entity and the @@ -1129,7 +1129,7 @@ default setting as example)." (defcustom vhdl-components-package-name '((".*" . "\\&_components") . "components") (concat - "*Specifies how the name for the components package is obtained. + "Specifies how the name for the components package is obtained. The components package is a package containing all component declarations for the current design. Its name can be obtained by modifying the project name \(e.g. attaching or stripping off a substring). If no project is defined, the @@ -1142,19 +1142,19 @@ DIRECTORY entry is chosen." :group 'vhdl-compose) (defcustom vhdl-use-components-package nil - "*Non-nil means use a separate components package for component declarations. + "Non-nil means use a separate components package for component declarations. Otherwise, component declarations are inserted and searched for in the architecture declarative parts." :type 'boolean :group 'vhdl-compose) (defcustom vhdl-compose-include-header t - "*Non-nil means include a header in automatically generated files." + "Non-nil means include a header in automatically generated files." :type 'boolean :group 'vhdl-compose) (defcustom vhdl-compose-create-files 'single - "*Specifies whether new files should be created for the new component. + "Specifies whether new files should be created for the new component. The component's entity and architecture are inserted: None : in current buffer Single file : in new single file @@ -1167,14 +1167,14 @@ The file names are obtained from variables `vhdl-entity-file-name' and :group 'vhdl-compose) (defcustom vhdl-compose-configuration-create-file nil - "*Specifies whether a new file should be created for the configuration. + "Specifies whether a new file should be created for the configuration. If non-nil, a new file is created for the configuration. The file name is obtained from variable `vhdl-configuration-file-name'." :type 'boolean :group 'vhdl-compose) (defcustom vhdl-compose-configuration-hierarchical t - "*Specifies whether hierarchical configurations should be created. + "Specifies whether hierarchical configurations should be created. If non-nil, automatically created configurations are hierarchical and include the whole hierarchy of subcomponents. Otherwise the configuration only includes one level of subcomponents." @@ -1182,7 +1182,7 @@ includes one level of subcomponents." :group 'vhdl-compose) (defcustom vhdl-compose-configuration-use-subconfiguration t - "*Specifies whether subconfigurations should be used inside configurations. + "Specifies whether subconfigurations should be used inside configurations. If non-nil, automatically created configurations use configurations in binding indications for subcomponents, if such configurations exist. Otherwise, entities are used in binding indications for subcomponents." @@ -1196,22 +1196,22 @@ entities are used in binding indications for subcomponents." :group 'vhdl-compose) (defcustom vhdl-include-port-comments nil - "*Non-nil means include port comments when a port is pasted." + "Non-nil means include port comments when a port is pasted." :type 'boolean :group 'vhdl-port) (defcustom vhdl-include-direction-comments nil - "*Non-nil means include port direction in instantiations as comments." + "Non-nil means include port direction in instantiations as comments." :type 'boolean :group 'vhdl-port) (defcustom vhdl-include-type-comments nil - "*Non-nil means include generic/port type in instantiations as comments." + "Non-nil means include generic/port type in instantiations as comments." :type 'boolean :group 'vhdl-port) (defcustom vhdl-include-group-comments 'never - "*Specifies whether to include group comments and spacings. + "Specifies whether to include group comments and spacings. The comments and empty lines between groups of ports are pasted: Never : never Declarations: in entity/component/constant/signal declarations only @@ -1223,7 +1223,7 @@ The comments and empty lines between groups of ports are pasted: (defcustom vhdl-actual-port-name '(".*" . "\\&") (concat - "*Specifies how actual port names are obtained from formal port names. + "Specifies how actual port names are obtained from formal port names. In a component instantiation, an actual port name can be obtained by modifying the formal port name (e.g. attaching or stripping off a substring)." vhdl-name-doc-string) @@ -1233,7 +1233,7 @@ modifying the formal port name (e.g. attaching or stripping off a substring)." (defcustom vhdl-instance-name '(".*" . "\\&_%d") (concat - "*Specifies how an instance name is obtained. + "Specifies how an instance name is obtained. The instance name can be obtained by modifying the name of the component to be instantiated (e.g. attaching or stripping off a substring). \"%d\" is replaced by a unique number (starting with 1). @@ -1250,7 +1250,7 @@ If TO STRING is empty, the instance name is queried." (defcustom vhdl-testbench-entity-name '(".*" . "\\&_tb") (concat - "*Specifies how the testbench entity name is obtained. + "Specifies how the testbench entity name is obtained. The entity name of a testbench can be obtained by modifying the name of the component to be tested (e.g. attaching or stripping off a substring)." vhdl-name-doc-string) @@ -1260,7 +1260,7 @@ the component to be tested (e.g. attaching or stripping off a substring)." (defcustom vhdl-testbench-architecture-name '(".*" . "") (concat - "*Specifies how the testbench architecture name is obtained. + "Specifies how the testbench architecture name is obtained. The testbench architecture name can be obtained by modifying the name of the component to be tested (e.g. attaching or stripping off a substring). If TO STRING is empty, the architecture name is queried." @@ -1271,7 +1271,7 @@ If TO STRING is empty, the architecture name is queried." (defcustom vhdl-testbench-configuration-name vhdl-compose-configuration-name (concat - "*Specifies how the testbench configuration name is obtained. + "Specifies how the testbench configuration name is obtained. The configuration name of a testbench can be obtained by modifying the entity and/or architecture name (e.g. attaching or stripping off a substring). The string that is matched against the regexp is the concatenation of the entity @@ -1284,7 +1284,7 @@ names (see default setting as example)." (defcustom vhdl-testbench-dut-name '(".*" . "DUT") (concat - "*Specifies how a DUT instance name is obtained. + "Specifies how a DUT instance name is obtained. The design-under-test instance name (i.e. the component instantiated in the testbench) can be obtained by modifying the component name (e.g. attaching or stripping off a substring)." @@ -1294,7 +1294,7 @@ or stripping off a substring)." :group 'vhdl-testbench) (defcustom vhdl-testbench-include-header t - "*Non-nil means include a header in automatically generated files." + "Non-nil means include a header in automatically generated files." :type 'boolean :group 'vhdl-testbench) @@ -1302,7 +1302,7 @@ or stripping off a substring)." -- clock signal Clk : std_logic := '1'; " - "*String or file to be inserted in the testbench declarative part. + "String or file to be inserted in the testbench declarative part. If the string specifies an existing file name, the contents of the file is inserted, otherwise the string itself is inserted in the testbench architecture before the BEGIN keyword. @@ -1322,7 +1322,7 @@ Type `C-j' for newlines." wait until Clk = '1'; end process WaveGen_Proc; " - "*String or file to be inserted in the testbench statement part. + "String or file to be inserted in the testbench statement part. If the string specifies an existing file name, the contents of the file is inserted, otherwise the string itself is inserted in the testbench architecture before the END keyword. @@ -1331,22 +1331,22 @@ Type `C-j' for newlines." :group 'vhdl-testbench) (defcustom vhdl-testbench-initialize-signals nil - "*Non-nil means initialize signals with `0' when declared in testbench." + "Non-nil means initialize signals with `0' when declared in testbench." :type 'boolean :group 'vhdl-testbench) (defcustom vhdl-testbench-include-library t - "*Non-nil means a library/use clause for std_logic_1164 is included." + "Non-nil means a library/use clause for std_logic_1164 is included." :type 'boolean :group 'vhdl-testbench) (defcustom vhdl-testbench-include-configuration t - "*Non-nil means a testbench configuration is attached at the end." + "Non-nil means a testbench configuration is attached at the end." :type 'boolean :group 'vhdl-testbench) (defcustom vhdl-testbench-create-files 'single - "*Specifies whether new files should be created for the testbench. + "Specifies whether new files should be created for the testbench. testbench entity and architecture are inserted: None : in current buffer Single file : in new single file @@ -1360,7 +1360,7 @@ and `vhdl-testbench-architecture-file-name'." (defcustom vhdl-testbench-entity-file-name vhdl-entity-file-name (concat - "*Specifies how the testbench entity file name is obtained. + "Specifies how the testbench entity file name is obtained. The entity file name can be obtained by modifying the testbench entity name \(e.g. attaching or stripping off a substring). The file extension is automatically taken from the file name of the current buffer. Testbench @@ -1373,7 +1373,7 @@ absolute path to the file name." (defcustom vhdl-testbench-architecture-file-name vhdl-architecture-file-name (concat - "*Specifies how the testbench architecture file name is obtained. + "Specifies how the testbench architecture file name is obtained. The architecture file name can be obtained by modifying the testbench entity and/or architecture name (e.g. attaching or stripping off a substring). The string that is matched against the regexp is the concatenation of the entity @@ -1392,17 +1392,17 @@ name." :group 'vhdl) (defcustom vhdl-self-insert-comments t - "*Non-nil means various templates automatically insert help comments." + "Non-nil means various templates automatically insert help comments." :type 'boolean :group 'vhdl-comment) (defcustom vhdl-prompt-for-comments t - "*Non-nil means various templates prompt for user definable comments." + "Non-nil means various templates prompt for user definable comments." :type 'boolean :group 'vhdl-comment) (defcustom vhdl-inline-comment-column 40 - "*Column to indent and align inline comments to. + "Column to indent and align inline comments to. Overrides local option `comment-column'. NOTE: Activate the new setting in a VHDL buffer by using the menu entry @@ -1411,7 +1411,7 @@ NOTE: Activate the new setting in a VHDL buffer by using the menu entry :group 'vhdl-comment) (defcustom vhdl-end-comment-column 79 - "*End of comment column. + "End of comment column. Comments that exceed this column number are wrapped. NOTE: Activate the new setting in a VHDL buffer by using the menu entry @@ -1427,19 +1427,19 @@ NOTE: Activate the new setting in a VHDL buffer by using the menu entry :group 'vhdl) (defcustom vhdl-auto-align t - "*Non-nil means align some templates automatically after generation." + "Non-nil means align some templates automatically after generation." :type 'boolean :group 'vhdl-align) (defcustom vhdl-align-groups t - "*Non-nil means align groups of code lines separately. + "Non-nil means align groups of code lines separately. A group of code lines is a region of consecutive lines between two lines that match the regexp in option `vhdl-align-group-separate'." :type 'boolean :group 'vhdl-align) (defcustom vhdl-align-group-separate "^\\s-*$" - "*Regexp for matching a line that separates groups of lines for alignment. + "Regexp for matching a line that separates groups of lines for alignment. Examples: \"^\\s-*$\": matches an empty line \"^\\s-*\\(--.*\\)?$\": matches an empty line or a comment-only line" @@ -1447,7 +1447,7 @@ Examples: :group 'vhdl-align) (defcustom vhdl-align-same-indent t - "*Non-nil means align blocks with same indent separately. + "Non-nil means align blocks with same indent separately. When a region or the entire buffer is aligned, the code is divided into blocks of same indent which are aligned separately (except for argument/port lists). This gives nicer alignment in most cases. @@ -1461,7 +1461,7 @@ Option `vhdl-align-groups' still applies within these blocks." :group 'vhdl) (defcustom vhdl-highlight-keywords t - "*Non-nil means highlight VHDL keywords and other standardized words. + "Non-nil means highlight VHDL keywords and other standardized words. The following faces are used: `font-lock-keyword-face' : keywords `font-lock-type-face' : standardized types @@ -1477,7 +1477,7 @@ NOTE: Activate the new setting in a VHDL buffer by re-fontifying it (menu :group 'vhdl-highlight) (defcustom vhdl-highlight-names t - "*Non-nil means highlight declaration names and construct labels. + "Non-nil means highlight declaration names and construct labels. The following faces are used: `font-lock-function-name-face' : names in declarations of units, subprograms, components, as well as labels of VHDL constructs @@ -1494,7 +1494,7 @@ NOTE: Activate the new setting in a VHDL buffer by re-fontifying it (menu :group 'vhdl-highlight) (defcustom vhdl-highlight-special-words nil - "*Non-nil means highlight words with special syntax. + "Non-nil means highlight words with special syntax. The words with syntax and color specified in option `vhdl-special-syntax-alist' are highlighted accordingly. Can be used for visual support of naming conventions. @@ -1507,7 +1507,7 @@ NOTE: Activate the new setting in a VHDL buffer by re-fontifying it (menu :group 'vhdl-highlight) (defcustom vhdl-highlight-forbidden-words nil - "*Non-nil means highlight forbidden words. + "Non-nil means highlight forbidden words. The reserved words specified in option `vhdl-forbidden-words' or having the syntax specified in option `vhdl-forbidden-syntax' are highlighted in a warning color (face `vhdl-font-lock-reserved-words-face') to indicate not to @@ -1522,7 +1522,7 @@ NOTE: Activate the new setting in a VHDL buffer by re-fontifying it (menu :group 'vhdl-highlight) (defcustom vhdl-highlight-verilog-keywords nil - "*Non-nil means highlight Verilog keywords as reserved words. + "Non-nil means highlight Verilog keywords as reserved words. Verilog keywords are highlighted in a warning color (face `vhdl-font-lock-reserved-words-face') to indicate not to use them. @@ -1535,7 +1535,7 @@ NOTE: Activate the new setting in a VHDL buffer by re-fontifying it (menu :group 'vhdl-highlight) (defcustom vhdl-highlight-translate-off nil - "*Non-nil means background-highlight code excluded from translation. + "Non-nil means background-highlight code excluded from translation. That is, all code between \"-- pragma translate_off\" and \"-- pragma translate_on\" is highlighted using a different background color \(face `vhdl-font-lock-translate-off-face'). @@ -1549,7 +1549,7 @@ NOTE: Activate the new setting in a VHDL buffer by re-fontifying it (menu :group 'vhdl-highlight) (defcustom vhdl-highlight-case-sensitive nil - "*Non-nil means consider case for highlighting. + "Non-nil means consider case for highlighting. Possible trade-off: non-nil also upper-case VHDL words are highlighted, but case of words with special syntax is not considered @@ -1566,7 +1566,7 @@ NOTE: Activate the new setting in a VHDL buffer by re-fontifying it (menu '(("generic/constant" "\\w+_[cg]" "Gold3" "BurlyWood1") ("type" "\\w+_t" "ForestGreen" "PaleGreen") ("variable" "\\w+_v" "Grey50" "Grey80")) - "*List of special syntax to be highlighted. + "List of special syntax to be highlighted. If option `vhdl-highlight-special-words' is non-nil, words with the specified syntax (as regular expression) are highlighted in the corresponding color. @@ -1599,7 +1599,7 @@ NOTE: Activate a changed regexp in a VHDL buffer by re-fontifying it (menu :group 'vhdl-highlight) (defcustom vhdl-forbidden-words '() - "*List of forbidden words to be highlighted. + "List of forbidden words to be highlighted. If option `vhdl-highlight-forbidden-words' is non-nil, these reserved words are highlighted in a warning color to indicate not to use them. @@ -1612,7 +1612,7 @@ NOTE: Activate the new setting in a VHDL buffer by re-fontifying it (menu :group 'vhdl-highlight) (defcustom vhdl-forbidden-syntax "" - "*Syntax of forbidden words to be highlighted. + "Syntax of forbidden words to be highlighted. If option `vhdl-highlight-forbidden-words' is non-nil, words with this syntax are highlighted in a warning color to indicate not to use them. Can be used to highlight too long identifiers (e.g. \"\\w\\w\\w\\w\\w\\w\\w\\w\\w\\w+\" @@ -1627,7 +1627,7 @@ NOTE: Activate the new setting in a VHDL buffer by re-fontifying it (menu :group 'vhdl-highlight) (defcustom vhdl-directive-keywords '("pragma" "synopsys") - "*List of compiler directive keywords recognized for highlighting. + "List of compiler directive keywords recognized for highlighting. NOTE: Activate the new setting in a VHDL buffer by re-fontifying it (menu entry \"Fontify Buffer\")." @@ -1643,13 +1643,13 @@ NOTE: Activate the new setting in a VHDL buffer by re-fontifying it (menu :group 'vhdl) (defcustom vhdl-speedbar-auto-open nil - "*Non-nil means automatically open speedbar at startup. + "Non-nil means automatically open speedbar at startup. Alternatively, the speedbar can be opened from the VHDL menu." :type 'boolean :group 'vhdl-speedbar) (defcustom vhdl-speedbar-display-mode 'files - "*Specifies the default displaying mode when opening speedbar. + "Specifies the default displaying mode when opening speedbar. Alternatively, the displaying mode can be selected from the speedbar menu or by typing `f' (files), `h' (directory hierarchy) or `H' (project hierarchy)." :type '(choice (const :tag "Files" files) @@ -1658,7 +1658,7 @@ by typing `f' (files), `h' (directory hierarchy) or `H' (project hierarchy)." :group 'vhdl-speedbar) (defcustom vhdl-speedbar-scan-limit '(10000000 (1000000 50)) - "*Limits scanning of large files and netlists. + "Limits scanning of large files and netlists. Design units: maximum file size to scan for design units Hierarchy (instances of subcomponents): File size: maximum file size to scan for instances (in bytes) @@ -1685,18 +1685,18 @@ prevent the scanning of large netlists." :group 'vhdl-speedbar) (defcustom vhdl-speedbar-jump-to-unit t - "*Non-nil means jump to the design unit code when opened in a buffer. + "Non-nil means jump to the design unit code when opened in a buffer. The buffer cursor position is left unchanged otherwise." :type 'boolean :group 'vhdl-speedbar) (defcustom vhdl-speedbar-update-on-saving t - "*Automatically update design hierarchy when buffer is saved." + "Automatically update design hierarchy when buffer is saved." :type 'boolean :group 'vhdl-speedbar) (defcustom vhdl-speedbar-save-cache '(hierarchy display) - "*Automatically save modified hierarchy caches when exiting Emacs. + "Automatically save modified hierarchy caches when exiting Emacs. Hierarchy: design hierarchy information Display: displaying information (which design units to expand)" :type '(set (const :tag "Hierarchy" hierarchy) @@ -1704,7 +1704,7 @@ The buffer cursor position is left unchanged otherwise." :group 'vhdl-speedbar) (defcustom vhdl-speedbar-cache-file-name ".emacs-vhdl-cache-\\1-\\2" - "*Name of file for saving hierarchy cache. + "Name of file for saving hierarchy cache. \"\\1\" is replaced by the project name if a project is specified, \"directory\" otherwise. \"\\2\" is replaced by the user name (allows for different users to have cache files in the same directory). Can also have @@ -1718,20 +1718,20 @@ an absolute path (i.e. all caches can be stored in one global directory)." :group 'vhdl) (defcustom vhdl-index-menu nil - "*Non-nil means add an index menu for a source file when loading. + "Non-nil means add an index menu for a source file when loading. Alternatively, the speedbar can be used. Note that the index menu scans a file when it is opened, while speedbar only scans the file upon request." :type 'boolean :group 'vhdl-menu) (defcustom vhdl-source-file-menu nil - "*Non-nil means add a menu of all source files in current directory. + "Non-nil means add a menu of all source files in current directory. Alternatively, the speedbar can be used." :type 'boolean :group 'vhdl-menu) (defcustom vhdl-hideshow-menu nil - "*Non-nil means add hideshow menu and functionality at startup. + "Non-nil means add hideshow menu and functionality at startup. Hideshow can also be enabled from the VHDL Mode menu. Hideshow allows hiding code of various VHDL constructs. @@ -1741,7 +1741,7 @@ NOTE: Activate the new setting in a VHDL buffer by using the menu entry :group 'vhdl-menu) (defcustom vhdl-hide-all-init nil - "*Non-nil means hide all design units initially after a file is loaded." + "Non-nil means hide all design units initially after a file is loaded." :type 'boolean :group 'vhdl-menu) @@ -1751,7 +1751,7 @@ NOTE: Activate the new setting in a VHDL buffer by using the menu entry :group 'vhdl) (defcustom vhdl-print-two-column t - "*Non-nil means print code in two columns and landscape format. + "Non-nil means print code in two columns and landscape format. Adjusts settings in a way that PostScript printing (\"File\" menu, `ps-print') prints VHDL files in a nice two-column landscape style. @@ -1761,7 +1761,7 @@ NOTE: Activate the new setting by restarting Emacs. :group 'vhdl-print) (defcustom vhdl-print-customize-faces t - "*Non-nil means use an optimized set of faces for PostScript printing. + "Non-nil means use an optimized set of faces for PostScript printing. NOTE: Activate the new setting by restarting Emacs. Overrides `ps-print' settings locally." @@ -1774,7 +1774,7 @@ NOTE: Activate the new setting by restarting Emacs. :group 'vhdl) (defcustom vhdl-intelligent-tab t - "*Non-nil means `TAB' does indentation, word completion and tab insertion. + "Non-nil means `TAB' does indentation, word completion and tab insertion. That is, if preceding character is part of a word then complete word, else if not at beginning of line then insert tab, else if last command was a `TAB' or `RET' then dedent one step, @@ -1788,28 +1788,28 @@ NOTE: Activate the new setting in a VHDL buffer by using the menu entry :group 'vhdl-misc) (defcustom vhdl-indent-syntax-based t - "*Non-nil means indent lines of code based on their syntactic context. + "Non-nil means indent lines of code based on their syntactic context. Otherwise, a line is indented like the previous nonblank line. This can be useful in large files where syntax-based indentation gets very slow." :type 'boolean :group 'vhdl-misc) (defcustom vhdl-word-completion-case-sensitive nil - "*Non-nil means word completion using `TAB' is case sensitive. + "Non-nil means word completion using `TAB' is case sensitive. That is, `TAB' completes words that start with the same letters and case. Otherwise, case is ignored." :type 'boolean :group 'vhdl-misc) (defcustom vhdl-word-completion-in-minibuffer t - "*Non-nil enables word completion in minibuffer (for template prompts). + "Non-nil enables word completion in minibuffer (for template prompts). NOTE: Activate the new setting by restarting Emacs." :type 'boolean :group 'vhdl-misc) (defcustom vhdl-underscore-is-part-of-word nil - "*Non-nil means consider the underscore character `_' as part of word. + "Non-nil means consider the underscore character `_' as part of word. An identifier containing underscores is then treated as a single word in select and move operations. All parts of an identifier separated by underscore are treated as single words otherwise. @@ -1844,24 +1844,24 @@ NOTE: Activate the new setting in a VHDL buffer by using the menu entry ;; Internal variables (defvar vhdl-menu-max-size 20 - "*Specifies the maximum size of a menu before splitting it into submenus.") + "Specifies the maximum size of a menu before splitting it into submenus.") (defvar vhdl-progress-interval 1 - "*Interval used to update progress status during long operations. + "Interval used to update progress status during long operations. If a number, percentage complete gets updated after each interval of that many seconds. To inhibit all messages, set this option to nil.") (defvar vhdl-inhibit-startup-warnings-p nil - "*If non-nil, inhibits start up compatibility warnings.") + "If non-nil, inhibits start up compatibility warnings.") (defvar vhdl-strict-syntax-p nil - "*If non-nil, all syntactic symbols must be found in `vhdl-offsets-alist'. + "If non-nil, all syntactic symbols must be found in `vhdl-offsets-alist'. If the syntactic symbol for a particular line does not match a symbol in the offsets alist, an error is generated, otherwise no error is reported and the syntactic symbol is ignored.") (defvar vhdl-echo-syntactic-information-p nil - "*If non-nil, syntactic info is echoed when the line is indented.") + "If non-nil, syntactic info is echoed when the line is indented.") (defconst vhdl-offsets-alist-default '((string . -1000) @@ -1889,7 +1889,7 @@ Do not change this constant! See the variable `vhdl-offsets-alist' for more information.") (defvar vhdl-offsets-alist (copy-alist vhdl-offsets-alist-default) - "*Association list of syntactic element symbols and indentation offsets. + "Association list of syntactic element symbols and indentation offsets. As described below, each cons cell in this list has the form: (SYNTACTIC-SYMBOL . OFFSET) @@ -1950,7 +1950,7 @@ Here is the current list of valid syntactic element symbols: package-body -- inside a package body") (defvar vhdl-comment-only-line-offset 0 - "*Extra offset for line which contains only the start of a comment. + "Extra offset for line which contains only the start of a comment. Can contain an integer or a cons cell of the form: (NON-ANCHORED-OFFSET . ANCHORED-OFFSET) @@ -1961,7 +1961,7 @@ the amount of offset to give column-zero anchored comment-only lines. Just an integer as value is equivalent to (<val> . 0)") (defvar vhdl-special-indent-hook nil - "*Hook for user defined special indentation adjustments. + "Hook for user defined special indentation adjustments. This hook gets called after a line is indented by the mode.") (defvar vhdl-style-alist @@ -2003,7 +2003,7 @@ your style, only those that are different from the default.") (setq vhdl-style-alist (cons default vhdl-style-alist)))) (defvar vhdl-mode-hook nil - "*Hook called by `vhdl-mode'.") + "Hook called by `vhdl-mode'.") ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; diff --git a/lisp/progmodes/xscheme.el b/lisp/progmodes/xscheme.el index 1f50910330c..f9d83da1a3a 100644 --- a/lisp/progmodes/xscheme.el +++ b/lisp/progmodes/xscheme.el @@ -48,7 +48,7 @@ "Name of xscheme buffer that we're currently interacting with.") (defvar xscheme-expressions-ring-max 30 - "*Maximum length of Scheme expressions ring.") + "Maximum length of Scheme expressions ring.") (defvar xscheme-expressions-ring nil "List of expressions recently transmitted to the Scheme process.") @@ -116,12 +116,12 @@ from being inserted into the process-buffer.") :group 'lisp) (defcustom scheme-band-name nil - "*Band loaded by the `run-scheme' command." + "Band loaded by the `run-scheme' command." :type '(choice (const nil) string) :group 'xscheme) (defcustom scheme-program-arguments nil - "*Arguments passed to the Scheme program by the `run-scheme' command." + "Arguments passed to the Scheme program by the `run-scheme' command." :type '(choice (const nil) string) :group 'xscheme) diff --git a/lisp/simple.el b/lisp/simple.el index 64356ce8aa7..9fab1d6dd86 100644 --- a/lisp/simple.el +++ b/lisp/simple.el @@ -2150,7 +2150,7 @@ of `history-length', which see.") "Switch used to have the shell execute its command line argument.") (defvar shell-command-default-error-buffer nil - "*Buffer name for `shell-command' and `shell-command-on-region' error output. + "Buffer name for `shell-command' and `shell-command-on-region' error output. This buffer is used when `shell-command' or `shell-command-on-region' is run interactively. A value of nil means that output to stderr and stdout will be intermixed in the output stream.") @@ -5321,7 +5321,7 @@ Returns t if it really did any work." t))) (defvar comment-line-break-function 'comment-indent-new-line - "*Mode-specific function which line breaks and continues a comment. + "Mode-specific function which line breaks and continues a comment. This function is called during auto-filling when a comment syntax is defined. The function should take a single optional argument, which is a flag diff --git a/lisp/skeleton.el b/lisp/skeleton.el index 5838915b1f5..328f795ecd2 100644 --- a/lisp/skeleton.el +++ b/lisp/skeleton.el @@ -37,7 +37,7 @@ (defvar skeleton-transformation-function 'identity - "*If non-nil, function applied to literal strings before they are inserted. + "If non-nil, function applied to literal strings before they are inserted. It should take strings and characters and return them transformed, or nil which means no transformation. Typical examples might be `upcase' or `capitalize'.") @@ -95,11 +95,11 @@ skeleton elements.") (defvar skeleton-subprompt (substitute-command-keys "RET, \\<minibuffer-local-map>\\[abort-recursive-edit] or \\[help-command]") - "*Replacement for %s in prompts of recursive subskeletons.") + "Replacement for %s in prompts of recursive subskeletons.") (defvar skeleton-debug nil - "*If non-nil `define-skeleton' will override previous definition.") + "If non-nil `define-skeleton' will override previous definition.") (defvar skeleton-positions nil "List of positions marked with @, after skeleton insertion. @@ -468,13 +468,13 @@ automatically, and you are prompted to fill in the variable parts."))) ;; Variables and command for automatically inserting pairs like () or "". (defvar skeleton-pair nil - "*If this is nil pairing is turned off, no matter what else is set. + "If this is nil pairing is turned off, no matter what else is set. Otherwise modes with `skeleton-pair-insert-maybe' on some keys will attempt to insert pairs of matching characters.") (defvar skeleton-pair-on-word nil - "*If this is nil, paired insertion is inhibited before or inside a word.") + "If this is nil, paired insertion is inhibited before or inside a word.") (defvar skeleton-pair-filter-function (lambda () nil) diff --git a/lisp/subr.el b/lisp/subr.el index 497809a23e8..a6ad67283be 100644 --- a/lisp/subr.el +++ b/lisp/subr.el @@ -1968,7 +1968,7 @@ It can be retrieved with `(process-get PROCESS PROPNAME)'." ;;;; Input and display facilities. (defvar read-quoted-char-radix 8 - "*Radix for \\[quoted-insert] and other uses of `read-quoted-char'. + "Radix for \\[quoted-insert] and other uses of `read-quoted-char'. Legitimate radix values are 8, 10 and 16.") (custom-declare-variable-early diff --git a/lisp/textmodes/artist.el b/lisp/textmodes/artist.el index 72ae44bb60d..dedbfcbf338 100644 --- a/lisp/textmodes/artist.el +++ b/lisp/textmodes/artist.el @@ -349,7 +349,7 @@ Example: (defvar artist-pointer-shape (if (eq window-system 'x) x-pointer-crosshair nil) - "*If in X Windows, use this pointer shape while drawing with the mouse.") + "If in X Windows, use this pointer shape while drawing with the mouse.") (defcustom artist-text-renderer-function 'artist-figlet @@ -397,13 +397,13 @@ Example: ;; This is a defvar, not a defcustom, since the custom ;; package shows lists of characters as a lists of integers, ;; which is confusing - "*Characters (``color'') to use when spraying. + "Characters (``color'') to use when spraying. They should be ordered from the ``lightest'' to the ``heaviest'' since spraying replaces a light character with the next heavier one.") (defvar artist-spray-new-char ?. - "*Initial character to use when spraying. + "Initial character to use when spraying. This character is used if spraying upon a character that is not in `artist-spray-chars'. The character defined by this variable should be in `artist-spray-chars', or spraying will behave strangely.") diff --git a/lisp/textmodes/bib-mode.el b/lisp/textmodes/bib-mode.el index 01733f97042..c8881fa5f9d 100644 --- a/lisp/textmodes/bib-mode.el +++ b/lisp/textmodes/bib-mode.el @@ -137,7 +137,7 @@ with the cdr.") (defcustom bib-auto-capitalize t - "*True to automatically capitalize appropriate fields in Bib mode." + "True to automatically capitalize appropriate fields in Bib mode." :type 'boolean :group 'bib) diff --git a/lisp/textmodes/bibtex.el b/lisp/textmodes/bibtex.el index a873680a8c8..87a32ad47a9 100644 --- a/lisp/textmodes/bibtex.el +++ b/lisp/textmodes/bibtex.el @@ -917,7 +917,7 @@ to the directories specified in `bibtex-string-file-path'." :type '(repeat file)) (defvar bibtex-string-file-path (getenv "BIBINPUTS") - "*Colon separated list of paths to search for `bibtex-string-files'.") + "Colon separated list of paths to search for `bibtex-string-files'.") (defcustom bibtex-files nil "List of BibTeX files that are searched for entry keys. @@ -931,7 +931,7 @@ See also `bibtex-search-entry-globally'." directory file))) (defvar bibtex-file-path (getenv "BIBINPUTS") - "*Colon separated list of paths to search for `bibtex-files'.") + "Colon separated list of paths to search for `bibtex-files'.") (defcustom bibtex-search-entry-globally nil "If non-nil, interactive calls of `bibtex-search-entry' search globally. @@ -1614,7 +1614,7 @@ Initialized by `bibtex-set-dialect'.") ,@(mapcar (lambda (matcher) `((lambda (bound) (bibtex-font-lock-cite ',matcher bound)))) bibtex-cite-matcher-alist)) - "*Default expressions to highlight in BibTeX mode.") + "Default expressions to highlight in BibTeX mode.") (defvar bibtex-font-lock-url-regexp ;; Assume that field names begin at the beginning of a line. diff --git a/lisp/textmodes/flyspell.el b/lisp/textmodes/flyspell.el index 930fda0626b..24967ded154 100644 --- a/lisp/textmodes/flyspell.el +++ b/lisp/textmodes/flyspell.el @@ -436,7 +436,7 @@ like <img alt=\"Some thing.\">." ;; dash character machinery (defvar flyspell-consider-dash-as-word-delimiter-flag nil - "*Non-nil means that the `-' char is considered as a word delimiter.") + "Non-nil means that the `-' char is considered as a word delimiter.") (make-variable-buffer-local 'flyspell-consider-dash-as-word-delimiter-flag) (defvar flyspell-dash-dictionary nil) (make-variable-buffer-local 'flyspell-dash-dictionary) diff --git a/lisp/textmodes/ispell.el b/lisp/textmodes/ispell.el index 75e8bd5a87d..74c32817734 100644 --- a/lisp/textmodes/ispell.el +++ b/lisp/textmodes/ispell.el @@ -277,13 +277,13 @@ full featured `looking-back' function is missing." ;;; ******* THIS FILE IS WRITTEN FOR ISPELL VERSION 3.1+ (defcustom ispell-highlight-p 'block - "*Highlight spelling errors when non-nil. + "Highlight spelling errors when non-nil. When set to `block', assumes a block cursor with TTY displays." :type '(choice (const block) (const :tag "off" nil) (const :tag "on" t)) :group 'ispell) (defcustom ispell-lazy-highlight (boundp 'lazy-highlight-cleanup) - "*Controls the lazy-highlighting of spelling errors. + "Controls the lazy-highlighting of spelling errors. When non-nil, all text in the buffer matching the current spelling error is highlighted lazily using isearch lazy highlighting (see `lazy-highlight-initial-delay' and `lazy-highlight-interval')." @@ -293,7 +293,7 @@ error is highlighted lazily using isearch lazy highlighting (see :version "22.1") (defcustom ispell-highlight-face (if ispell-lazy-highlight 'isearch 'highlight) - "*The face used for Ispell highlighting. For Emacsen with overlays. + "The face used for Ispell highlighting. For Emacsen with overlays. Possible values are `highlight', `modeline', `secondary-selection', `region', and `underline'. This variable can be set by the user to whatever face they desire. @@ -303,7 +303,7 @@ slightly different." :group 'ispell) (defcustom ispell-check-comments t - "*Spelling of comments checked when non-nil. + "Spelling of comments checked when non-nil. When set to `exclusive', ONLY comments are checked. (For code comments). Warning! Not checking comments, when a comment start is embedded in strings, may produce undesired results." @@ -314,13 +314,13 @@ may produce undesired results." (lambda (a) (memq a '(nil t exclusive)))) (defcustom ispell-query-replace-choices nil - "*Corrections made throughout region when non-nil. + "Corrections made throughout region when non-nil. Uses `query-replace' (\\[query-replace]) for corrections." :type 'boolean :group 'ispell) (defcustom ispell-skip-tib nil - "*Does not spell check `tib' bibliography references when non-nil. + "Does not spell check `tib' bibliography references when non-nil. Skips any text between strings matching regular expressions `ispell-tib-ref-beginning' and `ispell-tib-ref-end'. @@ -337,13 +337,13 @@ That includes the [.5mm] type of number..." "Regexp matching the end of a Tib reference.") (defcustom ispell-keep-choices-win t - "*If non-nil, keep the `*Choices*' window for the entire spelling session. + "If non-nil, keep the `*Choices*' window for the entire spelling session. This minimizes redisplay thrashing." :type 'boolean :group 'ispell) (defcustom ispell-choices-win-default-height 2 - "*The default size of the `*Choices*' window, including the mode line. + "The default size of the `*Choices*' window, including the mode line. Must be greater than 1." :type 'integer :group 'ispell) @@ -366,18 +366,18 @@ Must be greater than 1." ((file-readable-p "/usr/share/lib/dict/words") "/usr/share/lib/dict/words") ((file-readable-p "/sys/dict") "/sys/dict")) - "*Alternate plain word-list dictionary for spelling help." + "Alternate plain word-list dictionary for spelling help." :type '(choice file (const :tag "None" nil)) :group 'ispell) (defcustom ispell-complete-word-dict nil - "*Plain word-list dictionary used for word completion if + "Plain word-list dictionary used for word completion if different from `ispell-alternate-dictionary'." :type '(choice file (const :tag "None" nil)) :group 'ispell) (defcustom ispell-message-dictionary-alist nil - "*List used by `ispell-message' to select a new dictionary. + "List used by `ispell-message' to select a new dictionary. It consists of pairs (REGEXP . DICTIONARY). If REGEXP is found in the message headers, `ispell-local-dictionary' will be set to DICTIONARY if `ispell-local-dictionary' is not buffer-local. @@ -389,7 +389,7 @@ E.g. you may use the following value: (defcustom ispell-message-fcc-skip 50000 - "*Query before saving Fcc message copy if attachment larger than this value. + "Query before saving Fcc message copy if attachment larger than this value. Always stores Fcc copy of message when nil." :type '(choice integer (const :tag "off" nil)) :group 'ispell) @@ -423,13 +423,13 @@ This must be an absolute file name." :group 'ispell) (defcustom ispell-look-p (file-exists-p ispell-look-command) - "*Non-nil means use `look' rather than `grep'. + "Non-nil means use `look' rather than `grep'. Default is based on whether `look' seems to be available." :type 'boolean :group 'ispell) (defcustom ispell-have-new-look nil - "*Non-nil means use the `-r' option (regexp) when running `look'." + "Non-nil means use the `-r' option (regexp) when running `look'." :type 'boolean :group 'ispell) @@ -445,13 +445,13 @@ When nil, Emacs uses pipes." :group 'ispell) (defcustom ispell-following-word nil - "*Non-nil means `ispell-word' checks the word around or after point. + "Non-nil means `ispell-word' checks the word around or after point. Otherwise `ispell-word' checks the preceding word." :type 'boolean :group 'ispell) (defcustom ispell-help-in-bufferp nil - "*Non-nil means display interactive keymap help in a buffer. + "Non-nil means display interactive keymap help in a buffer. The following values are supported: nil Expand the minibuffer and display a short help message there for a couple of seconds. @@ -463,12 +463,12 @@ The following values are supported: :group 'ispell) (defcustom ispell-quietly nil - "*Non-nil means suppress messages in `ispell-word'." + "Non-nil means suppress messages in `ispell-word'." :type 'boolean :group 'ispell) (defcustom ispell-format-word-function (function upcase) - "*Formatting function for displaying word being spell checked. + "Formatting function for displaying word being spell checked. The function must take one string argument and return a string." :type 'function :group 'ispell) @@ -484,7 +484,7 @@ window system by evaluating the following on startup to set this variable: ;;;###autoload (defcustom ispell-personal-dictionary nil - "*File name of your personal spelling dictionary, or nil. + "File name of your personal spelling dictionary, or nil. If nil, the default personal dictionary, (\"~/.ispell_DICTNAME\" for ispell or \"~/.aspell.LANG.pws\" for aspell) is used, where DICTNAME is the name of your default dictionary and LANG the two letter language code." @@ -493,7 +493,7 @@ default dictionary and LANG the two letter language code." :group 'ispell) (defcustom ispell-silently-savep nil - "*When non-nil, save personal dictionary without asking for confirmation." + "When non-nil, save personal dictionary without asking for confirmation." :type 'boolean :group 'ispell) @@ -527,7 +527,7 @@ is automatically set when defined in the file with either :group 'ispell) (defcustom ispell-extra-args nil - "*If non-nil, a list of extra switches to pass to the Ispell program. + "If non-nil, a list of extra switches to pass to the Ispell program. For example, (\"-W\" \"3\") to cause it to accept all 1-3 character words as correct. See also `ispell-dictionary-alist', which may be used for language-specific arguments." @@ -537,7 +537,7 @@ for language-specific arguments." (defcustom ispell-skip-html 'use-mode-name - "*Indicates whether ispell should skip spell checking of SGML markup. + "Indicates whether ispell should skip spell checking of SGML markup. If t, always skip SGML markup; if nil, never skip; if non-t and non-nil, guess whether SGML markup should be skipped according to the name of the buffer's major mode." @@ -549,7 +549,7 @@ buffer's major mode." (defcustom ispell-local-dictionary-alist nil - "*List of local or customized dictionary definitions. + "List of local or customized dictionary definitions. These can override the values in `ispell-dictionary-alist'. To make permanent changes to your dictionary definitions, you @@ -1470,7 +1470,7 @@ Valid forms include: ("list" ispell-tex-arg-end 2) ("program" . "\\\\end[ \t\n]*{[ \t\n]*program[ \t\n]*}") ("verbatim\\*?" . "\\\\end[ \t\n]*{[ \t\n]*verbatim\\*?[ \t\n]*}")))) - "*Lists of regions to be skipped in TeX mode. + "Lists of regions to be skipped in TeX mode. First list is used raw. Second list has key placed inside \\begin{}. @@ -1489,7 +1489,7 @@ for skipping in latex mode.") ("<[tT][tT]/" "/") ("<[^ \t\n>]" ">") ("&[^ \t\n;]" "[; \t\n]")) - "*Lists of start and end keys to skip in HTML buffers. + "Lists of start and end keys to skip in HTML buffers. Same format as `ispell-skip-region-alist'. Note - substrings of other matches must come last (e.g. \"<[tT][tT]/\" and \"<[^ \\t\\n>]\").") @@ -1513,7 +1513,7 @@ local variable syntax.") Ispell is then restarted because the local words could conflict.") (defvar ispell-parser 'use-mode-name - "*Indicates whether ispell should parse the current buffer as TeX Code. + "Indicates whether ispell should parse the current buffer as TeX Code. Special value `use-mode-name' tries to guess using the name of `major-mode'. Default parser is `nroff'. Currently the only other valid parser is `tex'. @@ -3530,7 +3530,7 @@ Don't read buffer-local settings or word lists." ;; Matches commonly used "cut" boundaries "^\\(- \\)?[-=_]+\\s ?\\(cut here\\|Environment Follows\\)") "\\|") - "*Text beyond which `ispell-message' will not spell-check. + "Text beyond which `ispell-message' will not spell-check. If it is a string, limit is the first occurrence of that regular expression. Otherwise, it must be a function which is called to get the limit.") (put 'ispell-message-text-end 'risky-local-variable t) diff --git a/lisp/textmodes/refbib.el b/lisp/textmodes/refbib.el index b473019643a..62fa68ca793 100644 --- a/lisp/textmodes/refbib.el +++ b/lisp/textmodes/refbib.el @@ -64,7 +64,7 @@ :group 'wp) (defcustom r2b-trace-on nil - "*Non-nil means trace conversion." + "Non-nil means trace conversion." :type 'boolean :group 'refbib) @@ -128,7 +128,7 @@ in `r2b-proceedings-list' (although it wouldn't cause an error)." This is in addition to the `r2b-capitalize-title-stop-words'.") (defcustom r2b-delimit-with-quote t - "*If true, then use \" to delimit fields, otherwise use braces." + "If true, then use \" to delimit fields, otherwise use braces." :type 'boolean :group 'refbib) @@ -204,12 +204,12 @@ This is in addition to the `r2b-capitalize-title-stop-words'.") (buffer-substring (match-beginning exp) (match-end exp))) (defcustom r2b-out-buf-name "*Out*" - "*Name of buffer for output from refer-to-bibtex." + "Name of buffer for output from refer-to-bibtex." :type 'string :group 'refbib) (defcustom r2b-log-name "*Log*" - "*Name of buffer for logs errors from refer-to-bibtex." + "Name of buffer for logs errors from refer-to-bibtex." :type 'string :group 'refbib) diff --git a/lisp/textmodes/reftex-dcr.el b/lisp/textmodes/reftex-dcr.el index ebda25ea932..b1e426c5566 100644 --- a/lisp/textmodes/reftex-dcr.el +++ b/lisp/textmodes/reftex-dcr.el @@ -316,7 +316,7 @@ With argument, actually select the window showing the cross reference." (run-hooks 'reftex-display-copied-context-hook))))) (defvar reftex-use-itimer-in-xemacs nil - "*Non-nil means use the idle timers in XEmacs for crossref display. + "Non-nil means use the idle timers in XEmacs for crossref display. Currently, idle timer restart is broken and we use the post-command-hook.") (defun reftex-toggle-auto-view-crossref () diff --git a/lisp/textmodes/reftex-vars.el b/lisp/textmodes/reftex-vars.el index 98135b7ce24..4c875a35b3e 100644 --- a/lisp/textmodes/reftex-vars.el +++ b/lisp/textmodes/reftex-vars.el @@ -294,7 +294,7 @@ select the nearest entry with the correct new level." (symbol :tag "function " my-level-func))))) (defcustom reftex-toc-max-level 100 - "*The maximum level of toc entries which will be included in the TOC. + "The maximum level of toc entries which will be included in the TOC. Section headings with a bigger level will be ignored. In RefTeX, chapters are level 1, sections are level 2 etc. This variable can be changed from within the *toc* buffer with the `t' key." @@ -302,7 +302,7 @@ This variable can be changed from within the *toc* buffer with the `t' key." :type 'integer) (defcustom reftex-part-resets-chapter nil - "*Non-nil means, \\part is like any other sectioning command. + "Non-nil means, \\part is like any other sectioning command. This means, part numbers will be included in the numbering of chapters, and chapter counters will be reset for each part. When nil (the default), parts are special, do not reset the chapter counter @@ -312,7 +312,7 @@ and also do not show up in chapter numbers." (defcustom reftex-auto-recenter-toc 'frame - "*Non-nil means, turn automatic recentering of *TOC* window on. + "Non-nil means, turn automatic recentering of *TOC* window on. When active, the *TOC* window will always show the section you are currently working in. Recentering happens whenever Emacs is idle for more than `reftex-idle-time' seconds. @@ -335,12 +335,12 @@ This feature can be turned on and off from the menu (const :tag "in dedicated frame only" frame))) (defcustom reftex-toc-split-windows-horizontally nil - "*Non-nil means, create TOC window by splitting window horizontally." + "Non-nil means, create TOC window by splitting window horizontally." :group 'reftex-table-of-contents-browser :type 'boolean) (defcustom reftex-toc-split-windows-fraction .3 - "*Fraction of the width or height of the frame to be used for TOC window. + "Fraction of the width or height of the frame to be used for TOC window. See also `reftex-toc-split-windows-horizontally'." :group 'reftex-table-of-contents-browser :type 'number) @@ -349,7 +349,7 @@ See also `reftex-toc-split-windows-horizontally'." "This variable is obsolete, use `reftex-toc-split-windows-fraction' instead.") (defcustom reftex-toc-keep-other-windows t - "*Non-nil means, split the selected window to display the *toc* buffer. + "Non-nil means, split the selected window to display the *toc* buffer. This helps to keep the window configuration, but makes the *toc* small. When nil, all other windows except the selected one will be deleted, so that the *toc* window fills half the frame." @@ -357,25 +357,25 @@ that the *toc* window fills half the frame." :type 'boolean) (defcustom reftex-toc-include-file-boundaries nil - "*Non-nil means, include file boundaries in *toc* buffer. + "Non-nil means, include file boundaries in *toc* buffer. This flag can be toggled from within the *toc* buffer with the `F' key." :group 'reftex-table-of-contents-browser :type 'boolean) (defcustom reftex-toc-include-labels nil - "*Non-nil means, include labels in *toc* buffer. + "Non-nil means, include labels in *toc* buffer. This flag can be toggled from within the *toc* buffer with the `l' key." :group 'reftex-table-of-contents-browser :type 'boolean) (defcustom reftex-toc-include-index-entries nil - "*Non-nil means, include index entries in *toc* buffer. + "Non-nil means, include index entries in *toc* buffer. This flag can be toggled from within the *toc* buffer with the `i' key." :group 'reftex-table-of-contents-browser :type 'boolean) (defcustom reftex-toc-confirm-promotion 2 - "*Non-nil means, promotion/demotion commands first prompt for confirmation. + "Non-nil means, promotion/demotion commands first prompt for confirmation. When nil, the command is executed immediately. When this is an integer N, ask for confirmation only if N or more section commands are going to be changed." @@ -386,21 +386,21 @@ changed." (number :tag "When more than N sections" :value 2))) (defcustom reftex-toc-include-context nil - "*Non-nil means, include context with labels in the *toc* buffer. + "Non-nil means, include context with labels in the *toc* buffer. Context will only be shown when labels are visible as well. This flag can be toggled from within the *toc* buffer with the `c' key." :group 'reftex-table-of-contents-browser :type 'boolean) (defcustom reftex-toc-follow-mode nil - "*Non-nil means, point in *toc* buffer will cause other window to follow. + "Non-nil means, point in *toc* buffer will cause other window to follow. The other window will show the corresponding part of the document. This flag can be toggled from within the *toc* buffer with the `f' key." :group 'reftex-table-of-contents-browser :type 'boolean) (defcustom reftex-revisit-to-follow nil - "*Non-nil means, follow-mode will revisit files if necessary. + "Non-nil means, follow-mode will revisit files if necessary. When nil, follow-mode will be suspended for stuff in unvisited files." :group 'reftex-table-of-contents-browser :group 'reftex-referencing-labels @@ -940,7 +940,7 @@ This is used to string together whole reference sets, like :type '(repeat (cons (character) (string)))) (defcustom reftex-vref-is-default nil - "*Non-nil means, the varioref macro \\vref is used as default. + "Non-nil means, the varioref macro \\vref is used as default. In the selection buffer, the `v' key toggles the reference macro between `\\ref' and `\\vref'. The value of this variable determines the default which is active when entering the selection process. @@ -951,7 +951,7 @@ the label types for which it should be true." ;;;###autoload(put 'reftex-vref-is-default 'safe-local-variable (lambda (x) (or (stringp x) (symbolp x)))) (defcustom reftex-fref-is-default nil - "*Non-nil means, the fancyref macro \\fref is used as default. + "Non-nil means, the fancyref macro \\fref is used as default. In the selection buffer, the `V' key toggles the reference macro between `\\ref', `\\fref' and `\\Fref'. The value of this variable determines the default which is active when entering the selection process. @@ -962,13 +962,13 @@ the label types for which it should be true." ;;;###autoload(put 'reftex-fref-is-default 'safe-local-variable (lambda (x) (or (stringp x) (symbolp x)))) (defcustom reftex-level-indent 2 - "*Number of spaces to be used for indentation per section level." + "Number of spaces to be used for indentation per section level." :group 'reftex-referencing-labels :type 'integer) ;;;###autoload(put 'reftex-level-indent 'safe-local-variable 'integerp) (defcustom reftex-guess-label-type t - "*Non-nil means, `reftex-reference' will try to guess the label type. + "Non-nil means, `reftex-reference' will try to guess the label type. To do that, RefTeX will look at the word before the cursor and compare it with the words given in `reftex-label-alist'. When it finds a match, RefTeX will immediately offer the correct label menu - otherwise it will prompt you for @@ -1009,7 +1009,7 @@ string to insert into the buffer." (defvar reftex-bibfile-ignore-list nil) ; compatibility (defcustom reftex-bibfile-ignore-regexps nil - "*List of regular expressions to exclude files in \\bibliography{..}. + "List of regular expressions to exclude files in \\bibliography{..}. File names matched by these regexps will not be parsed by RefTeX. Intended for files which contain only `@string' macro definitions and the like, which are ignored by RefTeX anyway." @@ -1018,7 +1018,7 @@ like, which are ignored by RefTeX anyway." :type '(repeat (regexp))) (defcustom reftex-default-bibliography nil - "*List of BibTeX database files which should be used if none are specified. + "List of BibTeX database files which should be used if none are specified. When `reftex-citation' is called from a document which has neither a `\\bibliography{..}' statement nor a `thebibliography' environment, RefTeX will scan these files instead. Intended for using `reftex-citation' @@ -1028,7 +1028,7 @@ path." :type '(repeat (file))) (defcustom reftex-sort-bibtex-matches 'reverse-year - "*Sorting of the entries found in BibTeX databases by reftex-citation. + "Sorting of the entries found in BibTeX databases by reftex-citation. Possible values: nil Do not sort entries. 'author Sort entries by author name. @@ -1041,7 +1041,7 @@ nil Do not sort entries. (const :tag "by year, reversed" reverse-year))) (defcustom reftex-cite-format 'default - "*The format of citations to be inserted into the buffer. + "The format of citations to be inserted into the buffer. It can be a string or an alist or a symbol. In the simplest case this is just the string \"\\cite{%l}\", which is also the default. See the definition of `reftex-cite-format-builtin' for more complex examples. @@ -1105,7 +1105,7 @@ E.g.: (setq reftex-cite-format 'natbib)" (string :tag "Format string" ""))))) (defcustom reftex-cite-prompt-optional-args 'maybe - "*Non-nil means, prompt for empty optional arguments in cite macros. + "Non-nil means, prompt for empty optional arguments in cite macros. When an entry in `reftex-cite-format' ist given with square brackets to indicate optional arguments (for example \\cite[][]{%l}), RefTeX can prompt for values. Possible values are: @@ -1123,7 +1123,7 @@ the buffer. See `reftex-cite-cleanup-optional-args'." (const :tag "Never" nil))) (defcustom reftex-cite-cleanup-optional-args t - "*Non-nil means, remove unnecessary empty optional arguments in cite macros. + "Non-nil means, remove unnecessary empty optional arguments in cite macros. The cite macros provided by some packages (for example natbib) allow specifying two optional arguments, one for a prefix to the citation, and a second for a postfix. When only one optional @@ -1141,7 +1141,7 @@ can be turned off." :type 'boolean) (defcustom reftex-comment-citations nil - "*Non-nil means add a comment for each citation describing the full entry. + "Non-nil means add a comment for each citation describing the full entry. The comment is formatted according to `reftex-cite-comment-format'." :group 'reftex-citation-support :type 'boolean) @@ -1195,7 +1195,7 @@ should return the string to insert into the buffer." :group 'reftex) (defcustom reftex-support-index t - "*Non-nil means, index entries are parsed as well. + "Non-nil means, index entries are parsed as well. Index support is resource intensive and the internal structure holding the parsed information can become quite big. Therefore it can be turned off. When this is nil and you execute a command which requires index support, @@ -1354,7 +1354,7 @@ has higher priority than this logical `or'." :type 'regexp) (defcustom reftex-index-phrases-search-whole-words t - "*Non-nil means phrases search will look for whole words, not subwords. + "Non-nil means phrases search will look for whole words, not subwords. This works by requiring word boundaries at the beginning and end of the search string. When the search phrase already has a non-word-char at one of these points, no word boundary is required there." @@ -1362,7 +1362,7 @@ at one of these points, no word boundary is required there." :type 'boolean) (defcustom reftex-index-phrases-case-fold-search t - "*Non-nil means, searching for index phrases will ignore case." + "Non-nil means, searching for index phrases will ignore case." :group 'reftex-index-support :type 'boolean) @@ -1375,7 +1375,7 @@ If the function returns nil, the current match is skipped." (function))) (defcustom reftex-index-phrases-skip-indexed-matches nil - "*Non-nil means, skip matches which appear to be indexed already. + "Non-nil means, skip matches which appear to be indexed already. When doing global indexing from the phrases buffer, searches for some phrases may match at places where that phrase was already indexed. In particular when indexing an already processed document again, this @@ -1387,7 +1387,7 @@ be ignored." :type 'boolean) (defcustom reftex-index-phrases-wrap-long-lines nil - "*Non-nil means, when indexing from the phrases buffer, wrap lines. + "Non-nil means, when indexing from the phrases buffer, wrap lines. Inserting indexing commands in a line makes the line longer - often so long that it does not fit onto the screen. When this variable is non-nil, newlines will be added as necessary before and/or after the @@ -1397,7 +1397,7 @@ phrase and its index command will always end up on a single line." :type 'boolean) (defcustom reftex-index-phrases-sort-prefers-entry nil - "*Non-nil means when sorting phrase lines, the explicit index entry is used. + "Non-nil means when sorting phrase lines, the explicit index entry is used. Phrase lines in the phrases buffer contain a search phrase, and sorting is normally based on these. Some phrase lines also have an explicit index argument specified. When this variable is non-nil, @@ -1406,7 +1406,7 @@ the index argument will be used for sorting." :type 'boolean) (defcustom reftex-index-phrases-sort-in-blocks t - "*Non-nil means, empty and comment lines separate phrase buffer into blocks. + "Non-nil means, empty and comment lines separate phrase buffer into blocks. Sorting will then preserve blocks, so that lines are re-arranged only within blocks." :group 'reftex-index-support @@ -1425,13 +1425,13 @@ to that section." :type '(string :tag "Capital letters")) (defcustom reftex-index-include-context nil - "*Non-nil means, display the index definition context in the index buffer. + "Non-nil means, display the index definition context in the index buffer. This flag may also be toggled from the index buffer with the `c' key." :group 'reftex-index-support :type 'boolean) (defcustom reftex-index-follow-mode nil - "*Non-nil means, point in *Index* buffer will cause other window to follow. + "Non-nil means, point in *Index* buffer will cause other window to follow. The other window will show the corresponding part of the document. This flag can be toggled from within the *Index* buffer with the `f' key." :group 'reftex-table-of-contents-browser @@ -1463,7 +1463,7 @@ which subgroup of the match should be highlighted." (integer :tag "Highlight Group")))) (defcustom reftex-auto-view-crossref t - "*Non-nil means, initially turn automatic viewing of crossref info on. + "Non-nil means, initially turn automatic viewing of crossref info on. Automatic viewing of crossref info normally uses the echo area. Whenever point is idle for more than `reftex-idle-time' seconds on the argument of a \\ref or \\cite macro, and no other message is being @@ -1478,20 +1478,20 @@ This feature can be turned on and off from the menu (const :tag "in Other Window" window))) (defcustom reftex-idle-time 1.2 - "*Time (secs) Emacs has to be idle before automatic crossref display is done. + "Time (secs) Emacs has to be idle before automatic crossref display is done. Applies also to toc recentering." :group 'reftex-viewing-cross-references :type 'number) (defcustom reftex-revisit-to-echo nil - "*Non-nil means, automatic citation display will revisit files if necessary. + "Non-nil means, automatic citation display will revisit files if necessary. When nil, citation display in echo area will only be active for cached entries and for BibTeX database files with live associated buffers." :group 'reftex-viewing-cross-references :type 'boolean) (defcustom reftex-cache-cite-echo t - "*Non-nil means, the information displayed in the echo area for cite macros + "Non-nil means, the information displayed in the echo area for cite macros is cached and even saved along with the parsing information. The cache survives document scans. In order to clear it, use M-x reftex-reset-mode." :group 'reftex-viewing-cross-references @@ -1511,7 +1511,7 @@ for X-Symbol, but may have other uses as well." :group 'reftex) (defcustom reftex-texpath-environment-variables '("TEXINPUTS") - "*List of specifications how to retrieve the search path for TeX files. + "List of specifications how to retrieve the search path for TeX files. Several entries are possible. - If an element is the name of an environment variable, its content is used. - If an element starts with an exclamation mark, it is used as a command @@ -1526,7 +1526,7 @@ See also `reftex-use-external-file-finders'." :type '(repeat (string :tag "Specification"))) (defcustom reftex-bibpath-environment-variables '("BIBINPUTS" "TEXBIB") - "*List of specifications how to retrieve search path for .bib database files. + "List of specifications how to retrieve search path for .bib database files. Several entries are possible. - If an element is the name of an environment variable, its content is used. - If an element starts with an exclamation mark, it is used as a command @@ -1543,7 +1543,7 @@ See also `reftex-use-external-file-finders'." (defcustom reftex-file-extensions '(("tex" . (".tex" ".ltx")) ("bib" . (".bib"))) - "*Association list with file extensions for different file types. + "Association list with file extensions for different file types. This is a list of items, each item is like: (TYPE . (DEF-EXT OTHER-EXT ...)) TYPE: File type like \"bib\" or \"tex\". @@ -1572,7 +1572,7 @@ Note that if you are using external file finders, this option has no effect." :type 'boolean) (defcustom reftex-search-unrecursed-path-first t - "*Non-nil means, search all specified directories before trying recursion. + "Non-nil means, search all specified directories before trying recursion. Thus, in a path \".//:/tex/\", search first \"./\", then \"/tex/\" and then all subdirectories of \"./\". If this option is nil, the subdirectories of \"./\" are searched before \"/tex/\". This is mainly for speed - most of the @@ -1583,7 +1583,7 @@ in wrong sequence." :type 'boolean) (defcustom reftex-use-external-file-finders nil - "*Non-nil means, use external programs to find files. + "Non-nil means, use external programs to find files. Normally, RefTeX searches the paths given in the environment variables TEXINPUTS and BIBINPUTS to find TeX files and BibTeX database files. With this option turned on, it calls an external program specified in the @@ -1595,7 +1595,7 @@ the variables `reftex-texpath-environment-variables' and (defcustom reftex-external-file-finders '(("tex" . "kpsewhich -format=.tex %f") ("bib" . "kpsewhich -format=.bib %f")) - "*Association list with external programs to call for finding files. + "Association list with external programs to call for finding files. Each entry is a cons cell (TYPE . PROGRAM). TYPE is either \"tex\" or \"bib\". PROGRAM is the external program to use with any arguments. %f will be replaced by the name of the file to be found. @@ -1612,7 +1612,7 @@ Only relevant when `reftex-use-external-file-finders' is non-nil." :group 'reftex) (defcustom reftex-keep-temporary-buffers 1 - "*Non-nil means, keep buffers created for parsing and lookup. + "Non-nil means, keep buffers created for parsing and lookup. RefTeX sometimes needs to visit files related to the current document. We distinguish files visited for PARSING: Parts of a multifile document loaded when (re)-parsing the document. @@ -1637,7 +1637,7 @@ upon the variable `reftex-initialize-temporary-buffers'." (const :tag "Keep lookup buffers only" 1))) (defcustom reftex-initialize-temporary-buffers nil - "*Non-nil means do initializations even when visiting file temporarily. + "Non-nil means do initializations even when visiting file temporarily. When nil, RefTeX may turn off find-file hooks and other stuff to briefly visit a file. When t, the full default initializations are done (find-file-hook etc.). @@ -1651,14 +1651,14 @@ do a minimal initialization." (function-item)))) (defcustom reftex-no-include-regexps '("\\.pstex_t\\'") - "*List of regular expressions to exclude certain input files from parsing. + "List of regular expressions to exclude certain input files from parsing. If the name of a file included via \\include or \\input is matched by any of the regular expressions in this list, that file is not parsed by RefTeX." :group 'reftex-optimizations-for-large-documents :type '(repeat (regexp))) (defcustom reftex-enable-partial-scans nil - "*Non-nil means, re-parse only 1 file when asked to re-parse. + "Non-nil means, re-parse only 1 file when asked to re-parse. Re-parsing is normally requested with a `C-u' prefix to many RefTeX commands, or with the `r' key in menus. When this option is t in a multifile document, we will only parse the current buffer, or the file associated with the label @@ -1669,7 +1669,7 @@ in menus." :type 'boolean) (defcustom reftex-allow-automatic-rescan t - "*Non-nil means, RefTeX may rescan the document when this seems necessary. + "Non-nil means, RefTeX may rescan the document when this seems necessary. Currently this applies only to rescanning after label insertion, when the new label cannot be inserted correctly into the internal label list." @@ -1677,7 +1677,7 @@ list." :type 'boolean) (defcustom reftex-save-parse-info nil - "*Non-nil means, save information gathered with parsing in a file. + "Non-nil means, save information gathered with parsing in a file. The file MASTER.rel in the same directory as MASTER.tex is used to save the information. When this variable is t, - accessing the parsing information for the first time in an editing session @@ -1688,13 +1688,13 @@ information. When this variable is t, :type 'boolean) (defcustom reftex-parse-file-extension ".rel" - "*File extension for the file in which parser information is stored. + "File extension for the file in which parser information is stored. This extension is added to the base name of the master file." :group 'reftex-optimizations-for-large-documents :type 'string) (defcustom reftex-use-multiple-selection-buffers nil - "*Non-nil means use a separate selection buffer for each label type. + "Non-nil means use a separate selection buffer for each label type. These buffers are kept from one selection to the next and need not to be created for each use - so the menu generally comes up faster. The selection buffers will be erased (and therefore updated) automatically @@ -1705,7 +1705,7 @@ when new labels in its category are added. See the variable :type 'boolean) (defcustom reftex-auto-update-selection-buffers t - "*Non-nil means, selection buffers will be updated automatically. + "Non-nil means, selection buffers will be updated automatically. When a new label is defined with `reftex-label', all selection buffers associated with that label category are emptied, in order to force an update upon next use. When nil, the buffers are left alone and have to be @@ -1724,14 +1724,14 @@ The value of this variable will only have any effect when :group 'reftex) (defcustom reftex-use-fonts t - "*Non-nil means, use fonts in *toc* and selection buffers. + "Non-nil means, use fonts in *toc* and selection buffers. Font-lock must be loaded as well to actually get fontified display. When changing this option, a rescan may be necessary to activate the change." :group 'reftex-fontification-configurations :type 'boolean) (defcustom reftex-refontify-context 1 - "*Non-nil means, re-fontify the context in the label menu with font-lock. + "Non-nil means, re-fontify the context in the label menu with font-lock. This slightly slows down the creation of the label menu. It is only necessary when you definitely want the context fontified. @@ -1748,7 +1748,7 @@ The option is ignored when `reftex-use-fonts' is nil." (const :tag "When necessary" 1))) (defcustom reftex-highlight-selection 'cursor - "*Non-nil mean, highlight selected text in selection and *toc* buffers. + "Non-nil mean, highlight selected text in selection and *toc* buffers. Normally, the text near the cursor is the selected text, and it is highlighted. This is the entry most keys in the selection and *toc* buffers act on. However, if you mainly use the mouse to select an @@ -1861,7 +1861,7 @@ bindings with this prefix bound to `reftex-extra-bindings-map'." :type 'boolean) (defcustom reftex-plug-into-AUCTeX nil - "*Plug-in flags for AUCTeX interface. + "Plug-in flags for AUCTeX interface. This variable is a list of 4 boolean flags. When a flag is non-nil, RefTeX will @@ -1896,7 +1896,7 @@ may require a restart of Emacs in order to become effective." ))) (defcustom reftex-allow-detached-macro-args nil - "*Non-nil means, allow arguments of macros to be detached by whitespace. + "Non-nil means, allow arguments of macros to be detached by whitespace. When this is t, `aaa' will be considered as argument of \\bb in the following construct: \\bbb [xxx] {aaa}." :group 'reftex-miscellaneous-configurations diff --git a/lisp/textmodes/sgml-mode.el b/lisp/textmodes/sgml-mode.el index 09f6b6b7cf2..46ba2cf8599 100644 --- a/lisp/textmodes/sgml-mode.el +++ b/lisp/textmodes/sgml-mode.el @@ -292,7 +292,7 @@ Any terminating `>' or `/' is not matched.") ;; for font-lock, but must be defvar'ed after ;; sgml-font-lock-keywords-1 and sgml-font-lock-keywords-2 above (defvar sgml-font-lock-keywords sgml-font-lock-keywords-1 - "*Rules for highlighting SGML code. See also `sgml-tag-face-alist'.") + "Rules for highlighting SGML code. See also `sgml-tag-face-alist'.") (defconst sgml-syntax-propertize-function (syntax-propertize-rules @@ -1843,7 +1843,7 @@ This takes effect when first loading the library.") ("u") ("var") ("wbr" t))) - "*Value of `sgml-tag-alist' for HTML mode.") + "Value of `sgml-tag-alist' for HTML mode.") (defvar html-tag-help `(,@sgml-tag-help @@ -1936,7 +1936,7 @@ This takes effect when first loading the library.") ("ul" . "Unordered list") ("var" . "Math variable face") ("wbr" . "Enable <br> within <nobr>")) - "*Value of `sgml-tag-help' for HTML mode.") + "Value of `sgml-tag-help' for HTML mode.") ;;;###autoload @@ -2010,7 +2010,7 @@ To work around that, do: (defvar html-imenu-regexp "\\s-*<h\\([1-9]\\)[^\n<>]*>\\(<[^\n<>]*>\\)*\\s-*\\([^\n<>]*\\)" - "*A regular expression matching a head line to be added to the menu. + "A regular expression matching a head line to be added to the menu. The first `match-string' should be a number from 1-9. The second `match-string' matches extra tags and is ignored. The third `match-string' will be the used in the menu.") diff --git a/lisp/textmodes/table.el b/lisp/textmodes/table.el index e98d78ad439..0463ac52b1e 100644 --- a/lisp/textmodes/table.el +++ b/lisp/textmodes/table.el @@ -844,7 +844,7 @@ simply by any key input." (defvar table-disable-menu (null (and (locate-library "easymenu") (require 'easymenu) (fboundp 'easy-menu-add-item))) - "*When non-nil, use of menu by table package is disabled. + "When non-nil, use of menu by table package is disabled. It must be set before loading this package `table.el' for the first time.") diff --git a/lisp/textmodes/tex-mode.el b/lisp/textmodes/tex-mode.el index c5cad045c3f..9472d7df879 100644 --- a/lisp/textmodes/tex-mode.el +++ b/lisp/textmodes/tex-mode.el @@ -265,7 +265,7 @@ Deleted when the \\[tex-region] or \\[tex-buffer] is next run, or when the tex shell terminates.") (defvar tex-command "tex" - "*Command to run TeX. + "Command to run TeX. If this string contains an asterisk \(`*'\), that is replaced by the file name; otherwise the value of `tex-start-options', the \(shell-quoted\) value of `tex-start-commands', and the file name are added at the end diff --git a/lisp/textmodes/texinfmt.el b/lisp/textmodes/texinfmt.el index 3ec59ebcd3e..d318a97d377 100644 --- a/lisp/textmodes/texinfmt.el +++ b/lisp/textmodes/texinfmt.el @@ -93,7 +93,7 @@ If optional argument HERE is non-nil, insert info at point." (@unnumberedsubsubsec . @unnumberedsubsec) (@subsubheading . @subheading) (@appendixsubsubsec . @appendixsubsec)) - "*An alist of next higher levels for chapters, sections, etc... + "An alist of next higher levels for chapters, sections, etc... For example, section to chapter, subsection to section. Used by `texinfo-raise-lower-sections'. The keys specify types of section; the values correspond to the next @@ -121,7 +121,7 @@ higher types.") (@unnumberedsubsubsec . @unnumberedsubsubsec) (@subsubheading . @subsubheading) (@appendixsubsubsec . @appendixsubsubsec)) - "*An alist of next lower levels for chapters, sections, etc... + "An alist of next lower levels for chapters, sections, etc... For example, chapter to section, section to subsection. Used by `texinfo-raise-lower-sections'. The keys specify types of section; the values correspond to the next @@ -174,7 +174,7 @@ and don't split the file if large. You can use `Info-tagify' and "done. Now save it." "done."))))) (defvar texinfo-region-buffer-name "*Info Region*" - "*Name of the temporary buffer used by \\[texinfo-format-region].") + "Name of the temporary buffer used by \\[texinfo-format-region].") (defvar texinfo-pre-format-hook nil "Hook called before the conversion of the Texinfo file to Info format. @@ -1918,7 +1918,7 @@ Used by @refill indenting command to avoid indenting within lists, etc.") ;; Texinfo commands. (defvar texinfo-extra-inter-column-width 0 - "*Number of extra spaces between entries (columns) in @multitable.") + "Number of extra spaces between entries (columns) in @multitable.") (defvar texinfo-multitable-buffer-name "*multitable-temporary-buffer*") (defvar texinfo-multitable-rectangle-name "texinfo-multitable-temp-") diff --git a/lisp/textmodes/texnfo-upd.el b/lisp/textmodes/texnfo-upd.el index 83ef834257a..70aa17cea6b 100644 --- a/lisp/textmodes/texnfo-upd.el +++ b/lisp/textmodes/texnfo-upd.el @@ -203,7 +203,7 @@ It comes after the chapter-level menu entries.") (3 . (concat "\\(^@\\)\\(" texinfo-section-level-regexp "\\)\\>[ \t]*")) (4 . (concat "\\(^@\\)\\(" texinfo-subsection-level-regexp "\\)\\>[ \t]+")) (5 . (concat "\\(^@\\)\\(" texinfo-subsubsection-level-regexp "\\)\\>[ \t]+"))) - "*Regexps for searching for same level sections in a Texinfo file. + "Regexps for searching for same level sections in a Texinfo file. The keys are strings specifying the general hierarchical level in the document; the values are regular expressions.") @@ -231,7 +231,7 @@ document; the values are regular expressions.") "\\|" texinfo-chapter-level-regexp "\\)\\>[ \t]*\\)"))) - "*Regexps for searching for higher level sections in a Texinfo file. + "Regexps for searching for higher level sections in a Texinfo file. The keys are strings specifying the general hierarchical level in the document; the values are regular expressions.") @@ -270,7 +270,7 @@ document; the values are regular expressions.") "\\)\\>[ \t]+\\)")) ;; There's nothing below 5, use a bogus regexp that can't match. (5 . "a\\(^\\)")) - "*Regexps for searching for lower level sections in a Texinfo file. + "Regexps for searching for lower level sections in a Texinfo file. The keys are strings specifying the general hierarchical level in the document; the values are regular expressions.") @@ -682,7 +682,7 @@ node within the section." ;; try 32, but perhaps 24 is better (defvar texinfo-column-for-description 32 - "*Column at which descriptions start in a Texinfo menu.") + "Column at which descriptions start in a Texinfo menu.") (defun texinfo-insert-menu (menu-list node-name) "Insert formatted menu at point. diff --git a/lisp/timezone.el b/lisp/timezone.el index 00e69aa39cc..5762f019315 100644 --- a/lisp/timezone.el +++ b/lisp/timezone.el @@ -51,7 +51,7 @@ ("GMT-4" . -400) ("GMT-5" . -500) ("GMT-6" . -600) ("GMT-7" . -700) ("GMT-8" . -800) ("GMT-9" . -900) ("GMT-10" . -1000) ("GMT-11" . -1100) ("GMT-12" . -1200)) - "*Time differentials of timezone from GMT in +-HHMM form. + "Time differentials of timezone from GMT in +-HHMM form. This list is obsolescent, and is present only for backwards compatibility, because time zone names are ambiguous in practice. Use `current-time-zone' instead.") diff --git a/lisp/type-break.el b/lisp/type-break.el index ee64fde1c67..f0c81125f0c 100644 --- a/lisp/type-break.el +++ b/lisp/type-break.el @@ -241,7 +241,7 @@ remove themselves after running.") ("" type-break-mode-line-break-message type-break-mode-line-warning)) - "*Format of messages in the mode line concerning typing breaks.") + "Format of messages in the mode line concerning typing breaks.") (defvar type-break-mode-line-break-message '(type-break-mode-line-break-message-p diff --git a/lisp/url/url-dav.el b/lisp/url/url-dav.el index 03527bceee7..085785524b7 100644 --- a/lisp/url/url-dav.el +++ b/lisp/url/url-dav.el @@ -478,7 +478,7 @@ names (ie: DAV:resourcetype)." ;;; Locking support (defvar url-dav-lock-identifier (concat "mailto:" user-mail-address) - "*URL used as contact information when creating locks in DAV. + "URL used as contact information when creating locks in DAV. This will be used as the contents of the DAV:owner/DAV:href tag to identify the owner of a LOCK when requesting it. This will be shown to other users when the DAV:lockdiscovery property is requested, so diff --git a/lisp/url/url-handlers.el b/lisp/url/url-handlers.el index 4bc5bd47488..d00a1174cdf 100644 --- a/lisp/url/url-handlers.el +++ b/lisp/url/url-handlers.el @@ -92,7 +92,7 @@ (defvar url-handler-regexp "\\`\\(https?\\|ftp\\|file\\|nfs\\)://" - "*A regular expression for matching URLs handled by `file-name-handler-alist'. + "A regular expression for matching URLs handled by `file-name-handler-alist'. Some valid URL protocols just do not make sense to visit interactively \(about, data, info, irc, mailto, etc\). This regular expression avoids conflicts with local files that look like URLs \(Gnus is diff --git a/lisp/url/url-ldap.el b/lisp/url/url-ldap.el index 7c988f9b119..0ea98cb06c9 100644 --- a/lisp/url/url-ldap.el +++ b/lisp/url/url-ldap.el @@ -64,7 +64,7 @@ ("facsimiletelephonenumber" . "Fax") ("postaladdress" . "Mailing Address") ("description" . "Notes")) - "*An assoc list mapping LDAP attribute names to pretty descriptions of them.") + "An assoc list mapping LDAP attribute names to pretty descriptions of them.") (defvar url-ldap-attribute-formatters '(("mail" . (lambda (x) (format "<a href='mailto:%s'>%s</a>" x x))) @@ -76,7 +76,7 @@ ("namingcontexts" . url-ldap-dn-formatter) ("defaultnamingcontext" . url-ldap-dn-formatter) ("member" . url-ldap-dn-formatter)) - "*An assoc list mapping LDAP attribute names to pretty formatters for them.") + "An assoc list mapping LDAP attribute names to pretty formatters for them.") (defsubst url-ldap-attribute-pretty-name (n) (or (cdr-safe (assoc (downcase n) url-ldap-pretty-names)) n)) diff --git a/lisp/url/url-nfs.el b/lisp/url/url-nfs.el index a22d105b1a1..bfab147f267 100644 --- a/lisp/url/url-nfs.el +++ b/lisp/url/url-nfs.el @@ -29,7 +29,7 @@ (defvar url-nfs-automounter-directory-spec "file:/net/%h%f" - "*How to invoke the NFS automounter. Certain % sequences are recognized. + "How to invoke the NFS automounter. Certain % sequences are recognized. %h -- the hostname of the NFS server %n -- the port # of the NFS server diff --git a/lisp/url/url-vars.el b/lisp/url/url-vars.el index a56eb4cc810..ff18049e97b 100644 --- a/lisp/url/url-vars.el +++ b/lisp/url/url-vars.el @@ -212,7 +212,7 @@ Should be an assoc list of headers/contents.") ;; FIXME!! (RFC 2616 gives examples like `compress, gzip'.) (defvar url-mime-encoding-string nil - "*String to send in the Accept-encoding: field in HTTP requests.") + "String to send in the Accept-encoding: field in HTTP requests.") ;; Perhaps the first few should actually be given decreasing `q's and ;; the list should be trimmed significantly. @@ -233,7 +233,7 @@ Generated according to current coding system priorities." ";q=0.5")))) (defvar url-mime-charset-string nil - "*String to send in the Accept-charset: field in HTTP requests. + "String to send in the Accept-charset: field in HTTP requests. The MIME charset corresponding to the most preferred coding system is given priority 1 and the rest are given priority 0.5.") @@ -364,7 +364,7 @@ Currently supported methods: (defvar url-parse-syntax-table (copy-syntax-table emacs-lisp-mode-syntax-table) - "*A syntax table for parsing URLs.") + "A syntax table for parsing URLs.") (modify-syntax-entry ?' "\"" url-parse-syntax-table) (modify-syntax-entry ?` "\"" url-parse-syntax-table) @@ -373,7 +373,7 @@ Currently supported methods: (modify-syntax-entry ?/ " " url-parse-syntax-table) (defvar url-load-hook nil - "*Hooks to be run after initializing the URL library.") + "Hooks to be run after initializing the URL library.") ;;; Make OS/2 happy - yeeks ;; (defvar tcp-binary-process-input-services nil diff --git a/lisp/vc/add-log.el b/lisp/vc/add-log.el index be7bba54378..b9c3d0d385a 100644 --- a/lisp/vc/add-log.el +++ b/lisp/vc/add-log.el @@ -1122,17 +1122,17 @@ parentheses." ;;;###autoload (defvar add-log-lisp-like-modes '(emacs-lisp-mode lisp-mode scheme-mode dsssl-mode lisp-interaction-mode) - "*Modes that look like Lisp to `add-log-current-defun'.") + "Modes that look like Lisp to `add-log-current-defun'.") ;;;###autoload (defvar add-log-c-like-modes '(c-mode c++-mode c++-c-mode objc-mode) - "*Modes that look like C to `add-log-current-defun'.") + "Modes that look like C to `add-log-current-defun'.") ;;;###autoload (defvar add-log-tex-like-modes '(TeX-mode plain-TeX-mode LaTeX-mode tex-mode) - "*Modes that look like TeX to `add-log-current-defun'.") + "Modes that look like TeX to `add-log-current-defun'.") (declare-function c-cpp-define-name "cc-cmds" ()) (declare-function c-defun-name "cc-cmds" ()) diff --git a/lisp/vc/cvs-status.el b/lisp/vc/cvs-status.el index a80197486a2..f803cc43441 100644 --- a/lisp/vc/cvs-status.el +++ b/lisp/vc/cvs-status.el @@ -395,7 +395,7 @@ the list is a three-string list TAG, KIND, REV." (cvs-tree-use-jisx0208 'jisx0208) ((char-displayable-p ?━) 'unicode) ((char-displayable-p (make-char 'japanese-jisx0208 40 44)) 'jisx0208)) - "*Non-nil if we should use the graphical glyphs from `japanese-jisx0208'. + "Non-nil if we should use the graphical glyphs from `japanese-jisx0208'. Otherwise, default to ASCII chars like +, - and |.") (defconst cvs-tree-char-space diff --git a/lisp/vc/ediff-diff.el b/lisp/vc/ediff-diff.el index 37b7fce6f32..6d67356852c 100644 --- a/lisp/vc/ediff-diff.el +++ b/lisp/vc/ediff-diff.el @@ -101,7 +101,7 @@ the command \\[ediff-show-diff-output]. Use the variable :group 'ediff-diff) (ediff-defvar-local ediff-ignore-case nil - "*If t, skip over difference regions that differ only in letter case. + "If t, skip over difference regions that differ only in letter case. This variable can be set either in .emacs or toggled interactively. Use `setq-default' if setting it in .emacs") @@ -165,12 +165,12 @@ This variable can be set either in .emacs or toggled interactively. Use `setq-default' if setting it in .emacs") (ediff-defvar-local ediff-ignore-similar-regions nil - "*If t, skip over difference regions that differ only in the white space and line breaks. + "If t, skip over difference regions that differ only in the white space and line breaks. This variable can be set either in .emacs or toggled interactively. Use `setq-default' if setting it in .emacs") (ediff-defvar-local ediff-auto-refine-limit 14000 - "*Auto-refine only the regions of this size \(in bytes\) or less.") + "Auto-refine only the regions of this size \(in bytes\) or less.") ;;; General @@ -1288,38 +1288,38 @@ delimiter regions")) ;;; Word functions used to refine the current diff (defvar ediff-forward-word-function 'ediff-forward-word - "*Function to call to move to the next word. + "Function to call to move to the next word. Used for splitting difference regions into individual words.") (make-variable-buffer-local 'ediff-forward-word-function) ;; \240 is Unicode symbol for nonbreakable whitespace (defvar ediff-whitespace " \n\t\f\r\240" - "*Characters constituting white space. + "Characters constituting white space. These characters are ignored when differing regions are split into words.") (make-variable-buffer-local 'ediff-whitespace) (defvar ediff-word-1 (if (featurep 'xemacs) "a-zA-Z---_" "-[:word:]_") - "*Characters that constitute words of type 1. + "Characters that constitute words of type 1. More precisely, [ediff-word-1] is a regexp that matches type 1 words. See `ediff-forward-word' for more details.") (make-variable-buffer-local 'ediff-word-1) (defvar ediff-word-2 "0-9.," - "*Characters that constitute words of type 2. + "Characters that constitute words of type 2. More precisely, [ediff-word-2] is a regexp that matches type 2 words. See `ediff-forward-word' for more details.") (make-variable-buffer-local 'ediff-word-2) (defvar ediff-word-3 "`'?!:;\"{}[]()" - "*Characters that constitute words of type 3. + "Characters that constitute words of type 3. More precisely, [ediff-word-3] is a regexp that matches type 3 words. See `ediff-forward-word' for more details.") (make-variable-buffer-local 'ediff-word-3) (defvar ediff-word-4 (concat "^" ediff-word-1 ediff-word-2 ediff-word-3 ediff-whitespace) - "*Characters that constitute words of type 4. + "Characters that constitute words of type 4. More precisely, [ediff-word-4] is a regexp that matches type 4 words. See `ediff-forward-word' for more details.") (make-variable-buffer-local 'ediff-word-4) diff --git a/lisp/vc/ediff-init.el b/lisp/vc/ediff-init.el index 2de5e4dbdaf..ad6d69ee924 100644 --- a/lisp/vc/ediff-init.el +++ b/lisp/vc/ediff-init.el @@ -594,7 +594,7 @@ highlighted using ASCII flags." (ediff-defvar-local ediff-start-narrowed t "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. + "Non-nil means: when finished, Ediff widens buffers A/B. Actually, Ediff restores the scope of visibility that existed at startup.") (defcustom ediff-keep-variants t diff --git a/lisp/vc/emerge.el b/lisp/vc/emerge.el index a48f2afecd5..f6942bc538d 100644 --- a/lisp/vc/emerge.el +++ b/lisp/vc/emerge.el @@ -524,10 +524,10 @@ replaced by emerge-fast-keymap.") (emerge-defvar-local emerge-old-keymap nil "The original local keymap for the merge buffer.") (emerge-defvar-local emerge-auto-advance nil - "*If non-nil, emerge-select-A and emerge-select-B automatically advance to + "If non-nil, emerge-select-A and emerge-select-B automatically advance to the next difference.") (emerge-defvar-local emerge-skip-prefers nil - "*If non-nil, differences for which there is a preference are automatically + "If non-nil, differences for which there is a preference are automatically skipped.") (emerge-defvar-local emerge-quit-hook nil "Hooks to run in the merge buffer after the merge has been finished. diff --git a/lisp/vc/log-edit.el b/lisp/vc/log-edit.el index 54d548c09da..db70f417393 100644 --- a/lisp/vc/log-edit.el +++ b/lisp/vc/log-edit.el @@ -161,7 +161,7 @@ can be obtained from `log-edit-files'." "21.1") (defvar log-edit-changelog-full-paragraphs cvs-changelog-full-paragraphs - "*If non-nil, include full ChangeLog paragraphs in the log. + "If non-nil, include full ChangeLog paragraphs in the log. This may be set in the ``local variables'' section of a ChangeLog, to indicate the policy for that ChangeLog. diff --git a/lisp/vc/pcvs-defs.el b/lisp/vc/pcvs-defs.el index 80a01f58531..ab45b313bd5 100644 --- a/lisp/vc/pcvs-defs.el +++ b/lisp/vc/pcvs-defs.el @@ -33,7 +33,7 @@ ;;;; START OF THINGS TO CHECK WHEN INSTALLING (defvar cvs-program "cvs" - "*Name or full path of the cvs executable.") + "Name or full path of the cvs executable.") (defvar cvs-version ;; With the divergence of the CVSNT codebase and version numbers, this is @@ -46,12 +46,12 @@ nil t) (cons (string-to-number (match-string 1)) (string-to-number (match-string 2)))))) - "*Version of `cvs' installed on your system. + "Version of `cvs' installed on your system. It must be in the (MAJOR . MINOR) format.") ;; FIXME: this is only used by cvs-mode-diff-backup (defvar cvs-diff-program (or (and (boundp 'diff-command) diff-command) "diff") - "*Name or full path of the best diff program you've got. + "Name or full path of the best diff program you've got. NOTE: there are some nasty bugs in the context diff variants of some vendor versions, such as the one in SunOS-4.") @@ -89,7 +89,7 @@ will select a shared-flag.") "List of flags whose settings is shared among several commands.") (defvar cvs-cvsroot nil - "*Specifies where the (current) cvs master repository is. + "Specifies where the (current) cvs master repository is. Overrides the environment variable $CVSROOT by sending \" -d dir\" to all CVS commands. This switch is useful if you have multiple CVS repositories. It can be set interactively with \\[cvs-change-cvsroot.] @@ -243,7 +243,7 @@ the directory name of the cvs buffer.") ;; Was '(expand-file-name " *cvs-tmp*" dir), but that causes them to ;; become non-hidden if uniquification is done `forward'. " *cvs-tmp*" - "*Name of the cvs temporary buffer. + "Name of the cvs temporary buffer. Output from cvs is placed here for asynchronous commands.") (defcustom cvs-idiff-imerge-handlers |