diff options
41 files changed, 336 insertions, 157 deletions
diff --git a/lisp/ChangeLog b/lisp/ChangeLog index 149e8be413..1b01269460 100644 --- a/lisp/ChangeLog +++ b/lisp/ChangeLog @@ -1,3 +1,37 @@ +2011-10-20 Chong Yidong <cyd@gnu.org> + + * emulation/cua-base.el (cua-mode): + * mail/footnote.el (footnote-mode): + * mail/mailabbrev.el (mail-abbrevs-mode): + * net/xesam.el (xesam-minor-mode): + * progmodes/bug-reference.el (bug-reference-mode): + * progmodes/cap-words.el (capitalized-words-mode): + * progmodes/compile.el (compilation-minor-mode) + (compilation-shell-minor-mode): + * progmodes/gud.el (gud-tooltip-mode): + * progmodes/hideif.el (hide-ifdef-mode): + * progmodes/idlw-shell.el (idlwave-shell-electric-debug-mode): + * progmodes/subword.el (subword-mode): + * progmodes/vhdl-mode.el (vhdl-electric-mode, vhdl-stutter-mode): + * progmodes/which-func.el (which-function-mode): + * term/tvi970.el (tvi970-set-keypad-mode): + * term/vt100.el (vt100-wide-mode): + * textmodes/flyspell.el (flyspell-mode): + * textmodes/ispell.el (ispell-minor-mode): + * textmodes/nroff-mode.el (nroff-electric-mode): + * textmodes/paragraphs.el (use-hard-newlines): + * textmodes/refill.el (refill-mode): + * textmodes/reftex.el (reftex-mode): + * textmodes/rst.el (rst-minor-mode): + * textmodes/sgml-mode.el (html-autoview-mode) + (sgml-electric-tag-pair-mode): + * textmodes/tex-mode.el (latex-electric-env-pair-mode): + * vc/diff-mode.el (diff-auto-refine-mode, diff-minor-mode): + * emulation/crisp.el (crisp-mode): + * emacs-lisp/eldoc.el (eldoc-mode): + * emacs-lisp/checkdoc.el (checkdoc-minor-mode): Doc fixes for new + minor mode behavior. + 2011-10-19 Juri Linkov <juri@jurta.org> * descr-text.el (describe-char): Add #x2010 and #x2011 to diff --git a/lisp/cedet/ChangeLog b/lisp/cedet/ChangeLog index 093e592c47..e622715ea2 100644 --- a/lisp/cedet/ChangeLog +++ b/lisp/cedet/ChangeLog @@ -1,3 +1,9 @@ +2011-10-19 Chong Yidong <cyd@gnu.org> + + * ede.el (ede-minor-mode,global-ede-mode): + * semantic.el (semantic-mode): Doc fix to reflect new + define-minor-mode calling behavior. + 2011-07-30 Chong Yidong <cyd@stupidchicken.com> * semantic/grammar.el (semantic-grammar-insert-defanalyzers): Fix diff --git a/lisp/cedet/ede.el b/lisp/cedet/ede.el index 307ccfdadd..2b5ca2ca3a 100644 --- a/lisp/cedet/ede.el +++ b/lisp/cedet/ede.el @@ -398,8 +398,9 @@ To be used in hook functions." (define-minor-mode ede-minor-mode "Toggle EDE (Emacs Development Environment) minor mode. -With non-nil argument ARG, enable EDE minor mode if ARG is -positive; otherwise, disable it. +With a prefix argument ARG, enable EDE minor mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +EDE minor mode if ARG is omitted or nil. If this file is contained, or could be contained in an EDE controlled project, then this mode is activated automatically @@ -458,8 +459,9 @@ ONOFF indicates enabling or disabling the mode." ;;;###autoload (define-minor-mode global-ede-mode "Toggle global EDE (Emacs Development Environment) mode. -With non-nil argument ARG, enable global EDE mode if ARG is -positive; otherwise, disable it. +With a prefix argument ARG, enable global EDE mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. This global minor mode enables `ede-minor-mode' in all buffers in an EDE controlled project." diff --git a/lisp/cedet/semantic.el b/lisp/cedet/semantic.el index ce9af0e12b..34d886b680 100644 --- a/lisp/cedet/semantic.el +++ b/lisp/cedet/semantic.el @@ -1055,8 +1055,10 @@ The possible elements of this list include the following: ;;;###autoload (define-minor-mode semantic-mode - "Toggle Semantic mode. -With ARG, turn Semantic mode on if ARG is positive, off otherwise. + "Toggle parser features (Semantic mode). +With a prefix argument ARG, enable Semantic mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +Semantic mode if ARG is omitted or nil. In Semantic mode, Emacs parses the buffers you visit for their semantic content. This information is used by a variety of diff --git a/lisp/emacs-lisp/checkdoc.el b/lisp/emacs-lisp/checkdoc.el index 7eb6e6ef76..c9e3202318 100644 --- a/lisp/emacs-lisp/checkdoc.el +++ b/lisp/emacs-lisp/checkdoc.el @@ -1237,9 +1237,10 @@ generating a buffered list of errors." ;;;###autoload (define-minor-mode checkdoc-minor-mode - "Toggle Checkdoc minor mode, a mode for checking Lisp doc strings. -With prefix ARG, turn Checkdoc minor mode on if ARG is positive, otherwise -turn it off. + "Toggle automatic docstring checking (Checkdoc minor mode). +With a prefix argument ARG, enable Checkdoc minor mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. In Checkdoc minor mode, the usual bindings for `eval-defun' which is bound to \\<checkdoc-minor-mode-map>\\[checkdoc-eval-defun] and `checkdoc-eval-current-buffer' are overridden to include diff --git a/lisp/emacs-lisp/eldoc.el b/lisp/emacs-lisp/eldoc.el index cd9b779bee..901b6d1bf6 100644 --- a/lisp/emacs-lisp/eldoc.el +++ b/lisp/emacs-lisp/eldoc.el @@ -149,14 +149,17 @@ This is used to determine if `eldoc-idle-delay' is changed by the user.") ;;;###autoload (define-minor-mode eldoc-mode - "Toggle ElDoc mode on or off. -In ElDoc mode, the echo area displays information about a -function or variable in the text where point is. If point is -on a documented variable, it displays the first line of that -variable's doc string. Otherwise it displays the argument list -of the function called in the expression point is on. - -With prefix ARG, turn ElDoc mode on if and only if ARG is positive." + "Toggle echo area display of Lisp objects at point (ElDoc mode). +With a prefix argument ARG, enable ElDoc mode if ARG is positive, +and disable it otherwise. If called from Lisp, enable ElDoc mode +if ARG is omitted or nil. + +ElDoc mode is a buffer-local minor mode. When enabled, the echo +area displays information about a function or variable in the +text where point is. If point is on a documented variable, it +displays the first line of that variable's doc string. Otherwise +it displays the argument list of the function called in the +expression point is on." :group 'eldoc :lighter eldoc-minor-mode-string (setq eldoc-last-message nil) (if eldoc-mode diff --git a/lisp/emulation/crisp.el b/lisp/emulation/crisp.el index b2806e8f8e..567a57949b 100644 --- a/lisp/emulation/crisp.el +++ b/lisp/emulation/crisp.el @@ -349,8 +349,10 @@ normal CRiSP binding) and when it is nil M-x will run ;;;###autoload (define-minor-mode crisp-mode - "Toggle CRiSP/Brief emulation minor mode. -With ARG, turn CRiSP mode on if ARG is positive, off otherwise." + "Toggle CRiSP/Brief emulation (CRiSP mode). +With a prefix argument ARG, enable CRiSP mode if ARG is positive, +and disable it otherwise. If called from Lisp, enable the mode +if ARG is omitted or nil." :keymap crisp-mode-map :lighter crisp-mode-modeline-string (when crisp-mode diff --git a/lisp/emulation/cua-base.el b/lisp/emulation/cua-base.el index b643d521ad..918402dc58 100644 --- a/lisp/emulation/cua-base.el +++ b/lisp/emulation/cua-base.el @@ -1531,16 +1531,17 @@ If ARG is the atom `-', scroll upward by nearly full screen." ;;;###autoload (define-minor-mode cua-mode - "Toggle CUA key-binding mode. -When enabled, using shifted movement keys will activate the -region (and highlight the region using `transient-mark-mode'), -and typed text replaces the active selection. - -Also when enabled, you can use C-z, C-x, C-c, and C-v to undo, -cut, copy, and paste in addition to the normal Emacs bindings. -The C-x and C-c keys only do cut and copy when the region is -active, so in most cases, they do not conflict with the normal -function of these prefix keys. + "Toggle Common User Access style editing (CUA mode). +With a prefix argument ARG, enable CUA mode if ARG is positive, +and disable it otherwise. If called from Lisp, enable the mode +if ARG is omitted or nil. + +CUA mode is a global minor mode. When enabled, typed text +replaces the active selection, and you can use C-z, C-x, C-c, and +C-v to undo, cut, copy, and paste in addition to the normal Emacs +bindings. The C-x and C-c keys only do cut and copy when the +region is active, so in most cases, they do not conflict with the +normal function of these prefix keys. If you really need to perform a command which starts with one of the prefix keys even when the region is active, you have three diff --git a/lisp/erc/ChangeLog b/lisp/erc/ChangeLog index 7c7f10de2c..d72d3f51bb 100644 --- a/lisp/erc/ChangeLog +++ b/lisp/erc/ChangeLog @@ -1,3 +1,11 @@ +2011-10-20 Chong Yidong <cyd@gnu.org> + + * erc.el (define-erc-module): Fix autogenerated docstring to + reflect Emacs 24 minor mode changes. + + * erc-fill.el (erc-fill-mode): + * erc-track.el (erc-track-minor-mode): Doc fix. + 2011-09-23 Antoine Levitt <antoine.levitt@gmail.com> * erc-button.el (erc-button-next-function): Scoping fix diff --git a/lisp/erc/erc-fill.el b/lisp/erc/erc-fill.el index 0b9a4051d6..3940cfbc9a 100644 --- a/lisp/erc/erc-fill.el +++ b/lisp/erc/erc-fill.el @@ -39,9 +39,12 @@ ;;;###autoload (autoload 'erc-fill-mode "erc-fill" nil t) (erc-define-minor-mode erc-fill-mode "Toggle ERC fill mode. -With numeric arg, turn ERC fill mode on if and only if arg is -positive. In ERC fill mode, messages in the channel buffers are -filled." +With a prefix argument ARG, enable ERC fill mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. + +ERC fill mode is a global minor mode. When enabled, messages in +the channel buffers are filled." nil nil nil :global t :group 'erc-fill (if erc-fill-mode diff --git a/lisp/erc/erc-track.el b/lisp/erc/erc-track.el index 28c1ced91c..b663aeed42 100644 --- a/lisp/erc/erc-track.el +++ b/lisp/erc/erc-track.el @@ -588,12 +588,15 @@ START is the minimum length of the name used." ;;;###autoload (define-minor-mode erc-track-minor-mode - "Global minor mode for tracking ERC buffers and showing activity in the -mode line. - -This exists for the sole purpose of providing the C-c C-SPC and -C-c C-@ keybindings. Make sure that you have enabled the track -module, otherwise the keybindings will not do anything useful." + "Toggle mode line display of ERC activity (ERC Track minor mode). +With a prefix argument ARG, enable ERC Track minor mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. + +ERC Track minor mode is a global minor mode. It exists for the +sole purpose of providing the C-c C-SPC and C-c C-@ keybindings. +Make sure that you have enabled the track module, otherwise the +keybindings will not do anything useful." :init-value nil :lighter "" :keymap erc-track-minor-mode-map diff --git a/lisp/erc/erc.el b/lisp/erc/erc.el index a4040b239c..2d8c2565f6 100644 --- a/lisp/erc/erc.el +++ b/lisp/erc/erc.el @@ -1242,7 +1242,9 @@ Example: (erc-define-minor-mode ,mode ,(format "Toggle ERC %S mode. -With arg, turn ERC %S mode on if and only if arg is positive. +With a prefix argument ARG, enable %s if ARG is positive, +and disable it otherwise. If called from Lisp, enable the mode +if ARG is omitted or nil. %s" name name doc) nil nil nil :global ,(not local-p) :group (quote ,group) diff --git a/lisp/gnus/ChangeLog b/lisp/gnus/ChangeLog index b7f41e22e5..cb4703885f 100644 --- a/lisp/gnus/ChangeLog +++ b/lisp/gnus/ChangeLog @@ -1,3 +1,9 @@ +2011-10-20 Chong Yidong <cyd@gnu.org> + + * gnus-cite.el (gnus-message-citation-mode): Doc fix (in Emacs 24, + calling a minor mode from Lisp with nil arg enables it, so we have to + make the working a bit ambiguous here). + 2011-10-18 Teodor Zlatanov <tzz@lifelogs.com> * gnus-util.el (gnus-bound-and-true-p): Macro for XEmacs compatibility. diff --git a/lisp/gnus/gnus-cite.el b/lisp/gnus/gnus-cite.el index d205437b81..7c36311356 100644 --- a/lisp/gnus/gnus-cite.el +++ b/lisp/gnus/gnus-cite.el @@ -1224,13 +1224,8 @@ Returns nil if there is no such line before LIMIT, t otherwise." (autoload 'font-lock-set-defaults "font-lock"))) (define-minor-mode gnus-message-citation-mode - "Toggle `gnus-message-citation-mode' in current buffer. -This buffer local minor mode provides additional font-lock support for -nested citations. -With prefix ARG, turn `gnus-message-citation-mode' on if and only if ARG -is positive. -Automatically turn `font-lock-mode' on when `gnus-message-citation-mode' -is turned on." + "Minor mode providing more font-lock support for nested citations. +When enabled, it automatically turns on `font-lock-mode'." nil ;; init-value "" ;; lighter nil ;; keymap diff --git a/lisp/mail/footnote.el b/lisp/mail/footnote.el index 8dac3be0e5..0f1669562d 100644 --- a/lisp/mail/footnote.el +++ b/lisp/mail/footnote.el @@ -788,9 +788,14 @@ being set it is automatically widened." ;;;###autoload (define-minor-mode footnote-mode - "Toggle footnote minor mode. -This minor mode provides footnote support for `message-mode'. To get -started, play around with the following keys: + "Toggle Footnote mode. +With a prefix argument ARG, enable Footnote mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. + +Footnode mode is a buffer-local minor mode. If enabled, it +provides footnote support for `message-mode'. To get started, +play around with the following keys: \\{footnote-minor-mode-map}" :lighter footnote-mode-line-string :keymap footnote-minor-mode-map diff --git a/lisp/mail/mailabbrev.el b/lisp/mail/mailabbrev.el index 901eb002dc..2472b8a187 100644 --- a/lisp/mail/mailabbrev.el +++ b/lisp/mail/mailabbrev.el @@ -133,7 +133,15 @@ ;;;###autoload (define-minor-mode mail-abbrevs-mode - "Non-nil means expand mail aliases as abbrevs, in certain message headers." + "Toggle abbrev expansion of mail aliases (Mail Abbrevs mode). +With a prefix argument ARG, enable Mail Abbrevs mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. + +Mail Abbrevs mode is a global minor mode. When enabled, +abbrev-like expansion is performed when editing certain mail +headers (those specified by `mail-abbrev-mode-regexp'), based on +the entries in your `mail-personal-alias-file'." :global t :group 'mail-abbrev :version "20.3" diff --git a/lisp/net/goto-addr.el b/lisp/net/goto-addr.el index 4e78a7d42c..1432c1e516 100644 --- a/lisp/net/goto-addr.el +++ b/lisp/net/goto-addr.el @@ -288,7 +288,7 @@ Also fontifies the buffer appropriately (see `goto-address-fontify-p' and ;;;###autoload (define-minor-mode goto-address-prog-mode - "Turn on `goto-address-mode', but only in comments and strings." + "Like `goto-address-mode', but only for comments and strings." nil "" nil diff --git a/lisp/net/xesam.el b/lisp/net/xesam.el index 64c26cfb2c..56e9cb68c6 100644 --- a/lisp/net/xesam.el +++ b/lisp/net/xesam.el @@ -516,9 +516,9 @@ engine specific, widget :notify function to visualize xesam:url." (define-minor-mode xesam-minor-mode "Toggle Xesam minor mode. -With no argument, this command toggles the mode. -Non-null prefix argument turns on the mode. -Null prefix argument turns off the mode. +With a prefix argument ARG, enable Xesam minor mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. When Xesam minor mode is enabled, all text which matches a previous Xesam query in this buffer is highlighted." diff --git a/lisp/progmodes/bug-reference.el b/lisp/progmodes/bug-reference.el index 8ec379afab..12eddfef1a 100644 --- a/lisp/progmodes/bug-reference.el +++ b/lisp/progmodes/bug-reference.el @@ -127,7 +127,10 @@ so that it is considered safe, see `enable-local-variables'.") ;;;###autoload (define-minor-mode bug-reference-mode - "Minor mode to buttonize bugzilla references in the current buffer." + "Toggle hyperlinking bug references in the buffer (Bug Reference mode). +With a prefix argument ARG, enable Bug Reference mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil." nil "" nil diff --git a/lisp/progmodes/cap-words.el b/lisp/progmodes/cap-words.el index 0ce84ae33a..d7b7dfef1e 100644 --- a/lisp/progmodes/cap-words.el +++ b/lisp/progmodes/cap-words.el @@ -60,9 +60,13 @@ Looks for word boundaries before capitals." ;;;###autoload (define-minor-mode capitalized-words-mode "Toggle Capitalized Words mode. +With a prefix argument ARG, enable Capitalized Words mode if ARG +is positive, and disable it otherwise. If called from Lisp, +enable the mode if ARG is omitted or nil. -In this minor mode, a word boundary occurs immediately before an -uppercase letter in a symbol. This is in addition to all the normal +Capitalized Words mode is a buffer-local minor mode. When +enabled, a word boundary occurs immediately before an uppercase +letter in a symbol. This is in addition to all the normal boundaries given by the syntax and category tables. There is no restriction to ASCII. diff --git a/lisp/progmodes/compile.el b/lisp/progmodes/compile.el index 619c423902..156c90159c 100644 --- a/lisp/progmodes/compile.el +++ b/lisp/progmodes/compile.el @@ -1968,12 +1968,15 @@ Optional argument MINOR indicates this is called from ;;;###autoload (define-minor-mode compilation-shell-minor-mode - "Toggle compilation shell minor mode. -With arg, turn compilation mode on if and only if arg is positive. -In this minor mode, all the error-parsing commands of the -Compilation major mode are available but bound to keys that don't -collide with Shell mode. See `compilation-mode'. -Turning the mode on runs the normal hook `compilation-shell-minor-mode-hook'." + "Toggle Compilation Shell minor mode. +With a prefix argument ARG, enable Compilation Shell minor mode +if ARG is positive, and disable it otherwise. If called from +Lisp, enable the mode if ARG is omitted or nil. + +When Compilation Shell minor mode is enabled, all the +error-parsing commands of the Compilation major mode are +available but bound to keys that don't collide with Shell mode. +See `compilation-mode'." nil " Shell-Compile" :group 'compilation (if compilation-shell-minor-mode @@ -1982,11 +1985,14 @@ Turning the mode on runs the normal hook `compilation-shell-minor-mode-hook'." ;;;###autoload (define-minor-mode compilation-minor-mode - "Toggle compilation minor mode. -With arg, turn compilation mode on if and only if arg is positive. -In this minor mode, all the error-parsing commands of the -Compilation major mode are available. See `compilation-mode'. -Turning the mode on runs the normal hook `compilation-minor-mode-hook'." + "Toggle Compilation minor mode. +With a prefix argument ARG, enable Compilation minor mode if ARG +is positive, and disable it otherwise. If called from Lisp, +enable the mode if ARG is omitted or nil. + +When Compilation minor mode is enabled, all the error-parsing +commands of Compilation major mode are available. See +`compilation-mode'." nil " Compilation" :group 'compilation (if compilation-minor-mode diff --git a/lisp/progmodes/gud.el b/lisp/progmodes/gud.el index 25a23fed29..7b3a289361 100644 --- a/lisp/progmodes/gud.el +++ b/lisp/progmodes/gud.el @@ -3255,7 +3255,10 @@ Treats actions as defuns." ;;;###autoload (define-minor-mode gud-tooltip-mode - "Toggle the display of GUD tooltips." + "Toggle the display of GUD tooltips. +With a prefix argument ARG, enable the feature if ARG is +positive, and disable it otherwise. If called from Lisp, enable +it if ARG is omitted or nil." :global t :group 'gud :group 'tooltip diff --git a/lisp/progmodes/hideif.el b/lisp/progmodes/hideif.el index 48d1ac4b85..374a45acec 100644 --- a/lisp/progmodes/hideif.el +++ b/lisp/progmodes/hideif.el @@ -214,11 +214,15 @@ ;;;###autoload (define-minor-mode hide-ifdef-mode - "Toggle Hide-Ifdef mode. This is a minor mode, albeit a large one. -With ARG, turn Hide-Ifdef mode on if arg is positive, off otherwise. -In Hide-Ifdef mode, code within #ifdef constructs that the C preprocessor -would eliminate may be hidden from view. Several variables affect -how the hiding is done: + "Toggle features to hide/show #ifdef blocks (Hide-Ifdef mode). +With a prefix argument ARG, enable Hide-Ifdef mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. + +Hide-Ifdef mode is a buffer-local minor mode for use with C and +C-like major modes. When enabled, code within #ifdef constructs +that the C preprocessor would eliminate may be hidden from view. +Several variables affect how the hiding is done: `hide-ifdef-env' An association list of defined and undefined symbols for the diff --git a/lisp/progmodes/idlw-shell.el b/lisp/progmodes/idlw-shell.el index b2cd24f0f9..18f47d14a3 100644 --- a/lisp/progmodes/idlw-shell.el +++ b/lisp/progmodes/idlw-shell.el @@ -4277,16 +4277,14 @@ Otherwise, just expand the file name." (defvar idlwave-shell-electric-debug-buffers nil) (define-minor-mode idlwave-shell-electric-debug-mode - "Toggle Electric Debug mode. -With no argument, this command toggles the mode. -Non-null prefix argument turns on the mode. -Null prefix argument turns off the mode. - -When Electric Debug mode is enabled, the many debugging commands are -available as single key sequences." -nil -" *Debugging*" -idlwave-shell-electric-debug-mode-map) + "Toggle Idlwave Shell Electric Debug mode. +With a prefix argument ARG, enable the mode if ARG is positive, +and disable it otherwise. If called from Lisp, enable the mode +if ARG is omitted or nil. + +When Idlwave Shell Electric Debug mode is enabled, the Idlwave +Shell debugging commands are available as single key sequences." + nil " *Debugging*" idlwave-shell-electric-debug-mode-map) (add-hook 'idlwave-shell-electric-debug-mode-on-hook diff --git a/lisp/progmodes/subword.el b/lisp/progmodes/subword.el index 1a403f50b1..9c61da8900 100644 --- a/lisp/progmodes/subword.el +++ b/lisp/progmodes/subword.el @@ -94,13 +94,19 @@ ;;;###autoload (define-minor-mode subword-mode - "Mode enabling subword movement and editing keys. -In spite of GNU Coding Standards, it is popular to name a symbol by -mixing uppercase and lowercase letters, e.g. \"GtkWidget\", -\"EmacsFrameClass\", \"NSGraphicsContext\", etc. Here we call these -mixed case symbols `nomenclatures'. Also, each capitalized (or -completely uppercase) part of a nomenclature is called a `subword'. -Here are some examples: + "Toggle subword movement and editing (Subword mode). +With a prefix argument ARG, enable Subword mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. + +Subword mode is a buffer-local minor mode. Enabling it remaps +word-based editing commands to subword-based commands that handle +symbols with mixed uppercase and lowercase letters, +e.g. \"GtkWidget\", \"EmacsFrameClass\", \"NSGraphicsContext\". + +Here we call these mixed case symbols `nomenclatures'. Each +capitalized (or completely uppercase) part of a nomenclature is +called a `subword'. Here are some examples: Nomenclature Subwords =========================================================== diff --git a/lisp/progmodes/vhdl-mode.el b/lisp/progmodes/vhdl-mode.el index 9aaf3059b7..d7aa82aee1 100644 --- a/lisp/progmodes/vhdl-mode.el +++ b/lisp/progmodes/vhdl-mode.el @@ -8029,12 +8029,16 @@ project is defined." (define-minor-mode vhdl-electric-mode "Toggle VHDL electric mode. -Turn on if ARG positive, turn off if ARG negative, toggle if ARG zero or nil." +With a prefix argument ARG, enable the mode if ARG is positive, +and disable it otherwise. If called from Lisp, enable it if ARG +is omitted or nil." :global t) (define-minor-mode vhdl-stutter-mode "Toggle VHDL stuttering mode. -Turn on if ARG positive, turn off if ARG negative, toggle if ARG zero or nil." +With a prefix argument ARG, enable the mode if ARG is positive, +and disable it otherwise. If called from Lisp, enable it if ARG +is omitted or nil." :global t) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; diff --git a/lisp/progmodes/which-func.el b/lisp/progmodes/which-func.el index 97e188139e..e27d07854c 100644 --- a/lisp/progmodes/which-func.el +++ b/lisp/progmodes/which-func.el @@ -236,12 +236,14 @@ It creates the Imenu index for the buffer, if necessary." ;; This is the name people would normally expect. ;;;###autoload (define-minor-mode which-function-mode - "Toggle Which Function mode, globally. -When Which Function mode is enabled, the current function name is -continuously displayed in the mode line, in certain major modes. - -With prefix ARG, turn Which Function mode on if arg is positive, -and off otherwise." + "Toggle mode line display of current function (Which Function mode). +With a prefix argument ARG, enable Which Function mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. + +Which Function mode is a global minor mode. When enabled, the +current function name is continuously displayed in the mode line, +in certain major modes." :global t :group 'which-func (when (timerp which-func-update-timer) (cancel-timer which-func-update-timer)) diff --git a/lisp/term/tvi970.el b/lisp/term/tvi970.el index 5d852e5210..e154074a03 100644 --- a/lisp/term/tvi970.el +++ b/lisp/term/tvi970.el @@ -104,14 +104,17 @@ ;; Should keypad numbers send ordinary digits or distinct escape sequences? (define-minor-mode tvi970-set-keypad-mode - "Set the current mode of the TVI 970 numeric keypad. -In ``numeric keypad mode'', the number keys on the keypad act as -ordinary digits. In ``alternate keypad mode'', the keys send distinct -escape sequences, meaning that they can have their own bindings, + "Toggle alternate keypad mode on TVI 970 keypad. +With a prefix argument ARG, enable the mode if ARG is positive, +and disable it otherwise. If called from Lisp, enable the mode +if ARG is omitted or nil. + +In ``alternate keypad mode'', the keys send distinct escape +sequences, meaning that they can have their own bindings, independent of the normal number keys. -With no argument, toggle between the two possible modes. -With a positive argument, select alternate keypad mode. -With a negative argument, select numeric keypad mode." + +When disabled, the terminal enters ``numeric keypad mode'', in +which the keypad's keys act as ordinary digits." :variable (terminal-parameter nil 'tvi970-keypad-numeric) (send-string-to-terminal (if (terminal-parameter nil 'tvi970-keypad-numeric) "\e=" "\e>"))) diff --git a/lisp/term/vt100.el b/lisp/term/vt100.el index 406c20a0e8..ca16f356b2 100644 --- a/lisp/term/vt100.el +++ b/lisp/term/vt100.el @@ -42,8 +42,9 @@ ;;; Controlling the screen width. (define-minor-mode vt100-wide-mode "Toggle 132/80 column mode for vt100s. -With positive argument, switch to 132-column mode. -With negative argument, switch to 80-column mode." +With a prefix argument ARG, switch to 132-column mode if ARG is +positive, and 80-column mode otherwise. If called from Lisp, +switch to 132-column mode if ARG is omitted or nil." :global t :init-value (= (frame-width) 132) (send-string-to-terminal (if vt100-wide-mode "\e[?3h" "\e[?3l")) (set-frame-width terminal-frame (if vt100-wide-mode 132 80))) diff --git a/lisp/textmodes/flyspell.el b/lisp/textmodes/flyspell.el index d496298768..4a57d00d70 100644 --- a/lisp/textmodes/flyspell.el +++ b/lisp/textmodes/flyspell.el @@ -469,12 +469,14 @@ See also `flyspell-duplicate-distance'." ;;;###autoload(defvar flyspell-mode nil) ;;;###autoload (define-minor-mode flyspell-mode - "Minor mode performing on-the-fly spelling checking. -This spawns a single Ispell process and checks each word. -The default flyspell behavior is to highlight incorrect words. -With no argument, this command toggles Flyspell mode. -With a prefix argument ARG, turn Flyspell minor mode on if ARG is positive, -otherwise turn it off. + "Toggle on-the-fly spell checking (Flyspell mode). +With a prefix argument ARG, enable Flyspell mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. + +Flyspell mode is a buffer-local minor mode. When enabled, it +spawns a single Ispell process and checks each word. The default +flyspell behavior is to highlight incorrect words. Bindings: \\[ispell-word]: correct words (using Ispell). diff --git a/lisp/textmodes/ispell.el b/lisp/textmodes/ispell.el index b76b0a303d..62f899d173 100644 --- a/lisp/textmodes/ispell.el +++ b/lisp/textmodes/ispell.el @@ -3462,15 +3462,21 @@ available on the net." ;;;###autoload (define-minor-mode ispell-minor-mode - "Toggle Ispell minor mode. -With prefix argument ARG, turn Ispell minor mode on if ARG is positive, -otherwise turn it off. + "Toggle last-word spell checking (Ispell minor mode). +With a prefix argument ARG, enable Ispell minor mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. -In Ispell minor mode, pressing SPC or RET -warns you if the previous word is incorrectly spelled. +Ispell minor mode is a buffer-local mior mode. When enabled, +typing SPC or RET warns you if the previous word is incorrectly +spelled. -All the buffer-local variables and dictionaries are ignored -- to read -them into the running ispell process, type \\[ispell-word] SPC." +All the buffer-local variables and dictionaries are ignored. To +read them into the running ispell process, type \\[ispell-word] +SPC. + +For spell-checking \"on the fly\", not just after typing SPC or +RET, use `flyspell-mode'." nil " Spell" ispell-minor-keymap) (defun ispell-minor-check () diff --git a/lisp/textmodes/nroff-mode.el b/lisp/textmodes/nroff-mode.el index 8fb0bd85da..1be78ed293 100644 --- a/lisp/textmodes/nroff-mode.el +++ b/lisp/textmodes/nroff-mode.el @@ -297,11 +297,17 @@ automatically inserts the matching closing request after point." (forward-char 1)))) (define-minor-mode nroff-electric-mode - "Toggle `nroff-electric-newline' minor mode. -`nroff-electric-newline' forces Emacs to check for an nroff request at the -beginning of the line, and insert the matching closing request if necessary. -This command toggles that mode (off->on, on->off), with an argument, -turns it on if arg is positive, otherwise off." + "Toggle automatic nroff request pairing (Nroff Electric mode). +With a prefix argument ARG, enable Nroff Electric mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. + +Nroff Electric mode is a buffer-local minor mode, for use with +`nroff-mode'. When enabled, Emacs checks for an nroff request at +the beginning of the line, and inserts the matching closing +request if necessary. This command toggles that mode (off->on, +on->off), with an argument, turns it on if arg is positive, +otherwise off." :lighter " Electric" (or (derived-mode-p 'nroff-mode) (error "Must be in nroff mode"))) diff --git a/lisp/textmodes/paragraphs.el b/lisp/textmodes/paragraphs.el index 8fd055f7d8..b47924bc1f 100644 --- a/lisp/textmodes/paragraphs.el +++ b/lisp/textmodes/paragraphs.el @@ -35,19 +35,23 @@ (put 'use-hard-newlines 'permanent-local t) (define-minor-mode use-hard-newlines - "Minor mode to distinguish hard and soft newlines. -When active, the functions `newline' and `open-line' add the + "Toggle distinguishing between hard and soft newlines. +With a prefix argument ARG, enable the feature if ARG is +positive, and disable it otherwise. If called from Lisp, enable +it if ARG is omitted or nil. + +When enabled, the functions `newline' and `open-line' add the text-property `hard' to newlines that they insert, and a line is only considered as a candidate to match `paragraph-start' or `paragraph-separate' if it follows a hard newline. -Prefix argument says to turn mode on if positive, off if negative. -When the mode is turned on, if there are newlines in the buffer but no hard -newlines, ask the user whether to mark as hard any newlines preceding a -`paragraph-start' line. From a program, second arg INSERT specifies whether -to do this; it can be `never' to change nothing, t or `always' to force -marking, `guess' to try to do the right thing with no questions, nil -or anything else to ask the user. +When enabling, if there are newlines in the buffer but no hard +newlines, ask the user whether to mark as hard any newlines +preceding a `paragraph-start' line. From a program, second arg +INSERT specifies whether to do this; it can be `never' to change +nothing, t or `always' to force marking, `guess' to try to do the +right thing with no questions, nil or anything else to ask the +user. Newlines not marked hard are called \"soft\", and are always internal to paragraphs. The fill functions insert and delete only soft newlines." diff --git a/lisp/textmodes/refill.el b/lisp/textmodes/refill.el index 474872955b..d60b7594c0 100644 --- a/lisp/textmodes/refill.el +++ b/lisp/textmodes/refill.el @@ -213,12 +213,17 @@ complex processing.") ;;;###autoload (define-minor-mode refill-mode - "Toggle Refill minor mode. -With prefix arg, turn Refill mode on if arg is positive, otherwise turn it off. + "Toggle automatic refilling (Refill mode). +With a prefix argument ARG, enable Refill mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. -When Refill mode is on, the current paragraph will be formatted when -changes are made within it. Self-inserting characters only cause -refilling if they would cause auto-filling." +Refill mode is a buffer-local minor mode. When enabled, the +current paragraph is refilled as you edit. Self-inserting +characters only cause refilling if they would cause +auto-filling. + +For true \"word wrap\" behavior, use `visual-line-mode' instead." :group 'refill :lighter " Refill" :keymap '(("\177" . backward-delete-char-untabify)) diff --git a/lisp/textmodes/reftex.el b/lisp/textmodes/reftex.el index 7e150bff99..6f6993980d 100644 --- a/lisp/textmodes/reftex.el +++ b/lisp/textmodes/reftex.el @@ -503,7 +503,13 @@ (put 'reftex-mode :menu-tag "RefTeX Mode") ;;;###autoload (define-minor-mode reftex-mode - "Minor mode with distinct support for \\label, \\ref and \\cite in LaTeX. + "Toggle RefTeX mode. +With a prefix argument ARG, enable RefTeX mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. + +RefTeX mode is a buffer-local minor mode with distinct support +for \\label, \\ref and \\cite in LaTeX. \\<reftex-mode-map>A Table of Contents of the entire (multifile) document with browsing capabilities is available with `\\[reftex-toc]'. diff --git a/lisp/textmodes/rst.el b/lisp/textmodes/rst.el index c1ce950522..f9fda7e0a7 100644 --- a/lisp/textmodes/rst.el +++ b/lisp/textmodes/rst.el @@ -442,11 +442,10 @@ font-locking of blocks. ;;;###autoload (define-minor-mode rst-minor-mode - "ReST Minor Mode. -Toggle ReST minor mode. -With no argument, this command toggles the mode. -Non-null prefix argument turns on the mode. -Null prefix argument turns off the mode. + "Toggle ReST minor mode. +With a prefix argument ARG, enable ReST minor mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. When ReST minor mode is enabled, the ReST mode keybindings are installed on top of the major mode bindings. Use this diff --git a/lisp/textmodes/sgml-mode.el b/lisp/textmodes/sgml-mode.el index 314fbf9671..be8dd9c913 100644 --- a/lisp/textmodes/sgml-mode.el +++ b/lisp/textmodes/sgml-mode.el @@ -841,7 +841,14 @@ Return non-nil if we skipped over matched tags." (delete-overlay (pop sgml-electric-tag-pair-overlays)))) (define-minor-mode sgml-electric-tag-pair-mode - "Automatically update the closing tag when editing the opening one." + "Toggle SGML Electric Tag Pair mode. +With a prefix argument ARG, enable the mode if ARG is positive, +and disable it otherwise. If called from Lisp, enable the mode +if ARG is omitted or nil. + +SGML Electric Tag Pair mode is a buffer-local minor mode for use +with `sgml-mode' and related maor modes. When enabled, editing +an opening markup tag automatically updates the closing tag." :lighter "/e" (if sgml-electric-tag-pair-mode (progn @@ -2024,9 +2031,14 @@ The third `match-string' will be the used in the menu.") (nreverse toc-index))) (define-minor-mode html-autoview-mode - "Toggle automatic viewing via `browse-url-of-buffer' upon saving buffer. -With positive prefix ARG always turns viewing on, with negative ARG always off. -Can be used as a value for `html-mode-hook'." + "Toggle viewing of HTML files on save (HTML Autoview mode). +With a prefix argument ARG, enable HTML Autoview mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. + +HTML Autoview mode is a buffer-local minor mode for use with +`html-mode'. If enabled, saving the file automatically runs +`browse-url-of-buffer' to view it." nil nil nil :group 'sgml (if html-autoview-mode diff --git a/lisp/textmodes/tex-mode.el b/lisp/textmodes/tex-mode.el index 428fc1db3a..deb92fc024 100644 --- a/lisp/textmodes/tex-mode.el +++ b/lisp/textmodes/tex-mode.el @@ -677,8 +677,14 @@ An alternative value is \" . \", if you use a font with a narrow period." (put-text-property start end 'latex-env-pair t))) (define-minor-mode latex-electric-env-pair-mode - "Automatically update the \\end arg when editing the \\begin one. -And vice-versa." + "Toggle Latex Electric Env Pair mode. +With a prefix argument ARG, enable the mode if ARG is positive, +and disable it otherwise. If called from Lisp, enable it if ARG +is omitted or nil. + +Latex Electric Env Pair mode is a buffer-local minor mode for use +with `latex-mode'. When enabled, typing a \\begin or \\end tag +automatically inserts its partner." :lighter "/e" (if latex-electric-env-pair-mode (add-hook 'before-change-functions diff --git a/lisp/url/ChangeLog b/lisp/url/ChangeLog index fbc267df44..1b6890e525 100644 --- a/lisp/url/ChangeLog +++ b/lisp/url/ChangeLog @@ -1,3 +1,7 @@ +2011-10-19 Chong Yidong <cyd@gnu.org> + + * url-handlers.el (url-handler-mode): Doc fix. + 2011-09-24 Christopher J. White <chris@grierwhite.com> (tiny change) * url-http.el (url-http-create-request): Avoid adding extra CRLF diff --git a/lisp/url/url-handlers.el b/lisp/url/url-handlers.el index fef0ef15e9..d5f7eb7dd3 100644 --- a/lisp/url/url-handlers.el +++ b/lisp/url/url-handlers.el @@ -100,7 +100,10 @@ particularly bad at this\).") ;;;###autoload (define-minor-mode url-handler-mode - "Use URL to handle URL-like file names." + "Toggle using `url' library for URL filenames (URL Handler mode). +With a prefix argument ARG, enable URL Handler mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil." :global t :group 'url (if (not (boundp 'file-name-handler-alist)) ;; Can't be turned ON anyway. diff --git a/lisp/vc/diff-mode.el b/lisp/vc/diff-mode.el index 392973e08f..9f0fa584b0 100644 --- a/lisp/vc/diff-mode.el +++ b/lisp/vc/diff-mode.el @@ -225,9 +225,16 @@ when editing big diffs)." "Keymap for `diff-minor-mode'. See also `diff-mode-shared-map'.") (define-minor-mode diff-auto-refine-mode - "Automatically highlight changes in detail as the user visits hunks. -When transitioning from disabled to enabled, -try to refine the current hunk, as well." + "Toggle automatic diff hunk highlighting (Diff Auto Refine mode). +With a prefix argument ARG, enable Diff Auto Refine mode if ARG +is positive, and disable it otherwise. If called from Lisp, +enable the mode if ARG is omitted or nil. + +Diff Auto Refine mode is a buffer-local minor mode used with +`diff-mode'. When enabled, Emacs automatically highlights +changes in detail as the user visits hunks. When transitioning +from disabled to enabled, it tries to refine the current hunk, as +well." :group 'diff-mode :init-value t :lighter nil ;; " Auto-Refine" (when diff-auto-refine-mode (condition-case-no-debug nil (diff-refine-hunk) (error nil)))) @@ -1306,7 +1313,11 @@ a diff with \\[diff-reverse-direction]. ;;;###autoload (define-minor-mode diff-minor-mode - "Minor mode for viewing/editing context diffs. + "Toggle Diff minor mode. +With a prefix argument ARG, enable Diff minor mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. + \\{diff-minor-mode-map}" :group 'diff-mode :lighter " Diff" ;; FIXME: setup font-lock |