From: Glenn Morris Date: Wed, 8 Feb 2012 02:12:24 +0000 (-0500) Subject: Minor-mode doc fixes for ARG behavior X-Git-Tag: emacs-pretest-24.0.94~249 X-Git-Url: https://code.delx.au/gnu-emacs/commitdiff_plain/e1ac4066d1bf11c7d1d9c3419fcf983aa743721e Minor-mode doc fixes for ARG behavior * lisp/completion.el (dynamic-completion-mode): * lisp/dirtrack.el (dirtrack-debug-mode): * lisp/electric.el (electric-layout-mode): * lisp/epa-mail.el (epa-mail-mode, epa-global-mail-mode): * lisp/face-remap.el (text-scale-mode, buffer-face-mode): * lisp/iimage.el (iimage-mode): * lisp/image-mode.el (image-transform-mode): * lisp/minibuffer.el (completion-in-region-mode): * lisp/scroll-lock.el (scroll-lock-mode): * lisp/simple.el (next-error-follow-minor-mode): * lisp/tar-mode.el (tar-subfile-mode): * lisp/tooltip.el (tooltip-mode): * lisp/vcursor.el (vcursor-use-vcursor-map): * lisp/wid-browse.el (widget-minor-mode): * lisp/emulation/tpu-edt.el (tpu-edt-mode): * lisp/emulation/tpu-extras.el (tpu-cursor-free-mode): * lisp/international/iso-ascii.el (iso-ascii-mode): * lisp/language/thai-util.el (thai-word-mode): * lisp/mail/supercite.el (sc-minor-mode): * lisp/net/goto-addr.el (goto-address-mode): * lisp/net/rcirc.el (rcirc-multiline-minor-mode, rcirc-track-minor-mode): * lisp/progmodes/cwarn.el (cwarn-mode): * lisp/progmodes/flymake.el (flymake-mode): * lisp/progmodes/glasses.el (glasses-mode): * lisp/progmodes/hideshow.el (hs-minor-mode): * lisp/progmodes/pascal.el (pascal-outline-mode): * lisp/textmodes/enriched.el (enriched-mode): * lisp/vc/smerge-mode.el (smerge-mode): Doc fixes (minor mode argument). * etc/NEWS: Related markup. --- diff --git a/etc/NEWS b/etc/NEWS index 5866a06525..6892265756 100644 --- a/etc/NEWS +++ b/etc/NEWS @@ -1012,6 +1012,7 @@ trouble seems to be an old-style backquote followed by a newline. view-file has since Emacs 22 (ie, it won't enable View mode if the major-mode is special). ++++ ** Passing a nil argument to a minor mode defined by define-minor-mode now turns the mode ON unconditionally. This is so that you can write, e.g. (add-hook 'text-mode-hook 'foo-minor-mode) diff --git a/lisp/ChangeLog b/lisp/ChangeLog index 2ac59b1649..40baf0df4b 100644 --- a/lisp/ChangeLog +++ b/lisp/ChangeLog @@ -1,3 +1,35 @@ +2012-02-08 Glenn Morris + + * completion.el (dynamic-completion-mode): + * dirtrack.el (dirtrack-debug-mode): + * electric.el (electric-layout-mode): + * epa-mail.el (epa-mail-mode, epa-global-mail-mode): + * face-remap.el (text-scale-mode, buffer-face-mode): + * iimage.el (iimage-mode): + * image-mode.el (image-transform-mode): + * minibuffer.el (completion-in-region-mode): + * scroll-lock.el (scroll-lock-mode): + * simple.el (next-error-follow-minor-mode): + * tar-mode.el (tar-subfile-mode): + * tooltip.el (tooltip-mode): + * vcursor.el (vcursor-use-vcursor-map): + * wid-browse.el (widget-minor-mode): + * emulation/tpu-edt.el (tpu-edt-mode): + * emulation/tpu-extras.el (tpu-cursor-free-mode): + * international/iso-ascii.el (iso-ascii-mode): + * language/thai-util.el (thai-word-mode): + * mail/supercite.el (sc-minor-mode): + * net/goto-addr.el (goto-address-mode): + * net/rcirc.el (rcirc-multiline-minor-mode, rcirc-track-minor-mode): + * progmodes/cwarn.el (cwarn-mode): + * progmodes/flymake.el (flymake-mode): + * progmodes/glasses.el (glasses-mode): + * progmodes/hideshow.el (hs-minor-mode): + * progmodes/pascal.el (pascal-outline-mode): + * textmodes/enriched.el (enriched-mode): + * vc/smerge-mode.el (smerge-mode): + Doc fixes (minor mode argument). + 2012-02-07 Eli Zaretskii * ls-lisp.el (ls-lisp-sanitize): New function. diff --git a/lisp/completion.el b/lisp/completion.el index 485305b6e4..ceb272fad6 100644 --- a/lisp/completion.el +++ b/lisp/completion.el @@ -2337,7 +2337,10 @@ TYPE is the type of the wrapper to be added. Can be :before or :under." ;;;###autoload (define-minor-mode dynamic-completion-mode - "Enable dynamic word-completion." + "Toggle dynamic word-completion on or off. +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." :global t ;; This is always good, not specific to dynamic-completion-mode. (define-key function-key-map [C-return] [?\C-\r]) diff --git a/lisp/dirtrack.el b/lisp/dirtrack.el index 07220f21ed..4f6236b240 100644 --- a/lisp/dirtrack.el +++ b/lisp/dirtrack.el @@ -203,7 +203,10 @@ directory." (define-minor-mode dirtrack-debug-mode - "Toggle Dirtrack debugging." + "Toggle Dirtrack debugging. +With a prefix argument ARG, enable Dirtrack debugging if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil." nil nil nil (if dirtrack-debug-mode (display-buffer (get-buffer-create dirtrack-debug-buffer)))) diff --git a/lisp/electric.el b/lisp/electric.el index 1c4b34e151..4ca27550f9 100644 --- a/lisp/electric.el +++ b/lisp/electric.el @@ -404,7 +404,10 @@ one of those symbols.") ;;;###autoload (define-minor-mode electric-layout-mode - "Automatically insert newlines around some chars." + "Automatically insert newlines around some chars. +With a prefix argument ARG, enable Electric Layout 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 'electricity (if electric-layout-mode diff --git a/lisp/emulation/tpu-edt.el b/lisp/emulation/tpu-edt.el index 6df8801e6b..56efa568f0 100644 --- a/lisp/emulation/tpu-edt.el +++ b/lisp/emulation/tpu-edt.el @@ -979,7 +979,10 @@ and the total number of lines in the buffer." ;;; ;;;###autoload (define-minor-mode tpu-edt-mode - "TPU/edt emulation." + "Toggle TPU/edt emulation on or off. +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." :global t (if tpu-edt-mode (tpu-edt-on) (tpu-edt-off))) diff --git a/lisp/emulation/tpu-extras.el b/lisp/emulation/tpu-extras.el index 53f617d882..521b189e3b 100644 --- a/lisp/emulation/tpu-extras.el +++ b/lisp/emulation/tpu-extras.el @@ -132,7 +132,10 @@ the previous line when starting from a line beginning." ;;;###autoload (define-minor-mode tpu-cursor-free-mode - "Minor mode to allow the cursor to move freely about the screen." + "Minor mode to allow the cursor to move freely about the screen. +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." :init-value nil (if (not tpu-cursor-free-mode) (tpu-trim-line-ends)) diff --git a/lisp/epa-mail.el b/lisp/epa-mail.el index b63890e4e8..22bfe03cab 100644 --- a/lisp/epa-mail.el +++ b/lisp/epa-mail.el @@ -47,7 +47,10 @@ ;;;###autoload (define-minor-mode epa-mail-mode - "A minor-mode for composing encrypted/clearsigned mails." + "A minor-mode for composing encrypted/clearsigned mails. +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." nil " epa-mail" epa-mail-mode-map) (defun epa-mail--find-usable-key (keys usage) @@ -202,7 +205,10 @@ Don't use this command in Lisp programs!" ;;;###autoload (define-minor-mode epa-global-mail-mode - "Minor mode to hook EasyPG into Mail mode." + "Minor mode to hook EasyPG into Mail 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." :global t :init-value nil :group 'epa-mail :version "23.1" (remove-hook 'mail-mode-hook 'epa-mail-mode) (if epa-global-mail-mode diff --git a/lisp/face-remap.el b/lisp/face-remap.el index 146cea80a9..3af9e31a6f 100644 --- a/lisp/face-remap.el +++ b/lisp/face-remap.el @@ -205,6 +205,9 @@ Each positive or negative step scales the default face height by this amount." (define-minor-mode text-scale-mode "Minor mode for displaying buffer text in a larger/smaller font. +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. The amount of scaling is determined by the variable `text-scale-mode-amount': one step scales the global default @@ -334,8 +337,10 @@ plist, etc." ;;;###autoload (define-minor-mode buffer-face-mode "Minor mode for a buffer-specific default face. -When enabled, the face specified by the variable -`buffer-face-mode-face' is used to display the buffer text." +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 enabled, the face specified by the +variable `buffer-face-mode-face' is used to display the buffer text." :lighter " BufFace" (when buffer-face-mode-remapping (face-remap-remove-relative buffer-face-mode-remapping)) diff --git a/lisp/iimage.el b/lisp/iimage.el index 674e885a24..a6180b263c 100644 --- a/lisp/iimage.el +++ b/lisp/iimage.el @@ -137,8 +137,7 @@ Examples of image filename patterns to match: '(display modification-hooks)))))))))) ;;;###autoload -(define-minor-mode iimage-mode - "Toggle inline image minor mode." +(define-minor-mode iimage-mode nil :group 'iimage :lighter " iImg" :keymap iimage-mode-map (iimage-mode-buffer iimage-mode)) diff --git a/lisp/image-mode.el b/lisp/image-mode.el index ba1fadf2c1..63241f4fe7 100644 --- a/lisp/image-mode.el +++ b/lisp/image-mode.el @@ -619,8 +619,10 @@ Otherwise it plays once, then stops." (define-minor-mode image-transform-mode "Minor mode for scaling and rotating images. -This minor mode has no effect unless Emacs is compiled with -ImageMagick support." +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. This minor mode requires Emacs to have +been compiled with ImageMagick support." nil "image-transform" image-transform-minor-mode-map) (defvar image-transform-resize nil diff --git a/lisp/international/iso-ascii.el b/lisp/international/iso-ascii.el index f994a93c04..0566b8ead5 100644 --- a/lisp/international/iso-ascii.el +++ b/lisp/international/iso-ascii.el @@ -1,6 +1,6 @@ ;;; iso-ascii.el --- set up char tables for ISO 8859/1 on ASCII terminals -;; Copyright (C) 1987, 1995, 1998, 2001-2012 Free Software Foundation, Inc. +;; Copyright (C) 1987, 1995, 1998, 2001-2012 Free Software Foundation, Inc. ;; Author: Howard Gayle ;; Maintainer: FSF @@ -163,7 +163,10 @@ (iso-ascii-display 255 "\"y") ; small y with diaeresis or umlaut mark (define-minor-mode iso-ascii-mode - "Toggle ISO-ASCII mode." + "Toggle ISO-ASCII 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." :variable (eq standard-display-table iso-ascii-display-table) (unless standard-display-table (setq standard-display-table iso-ascii-standard-display-table))) diff --git a/lisp/language/thai-util.el b/lisp/language/thai-util.el index 4cfee92e0e..ff5eac8648 100644 --- a/lisp/language/thai-util.el +++ b/lisp/language/thai-util.el @@ -1,6 +1,6 @@ ;;; thai-util.el --- utilities for Thai -*- coding: utf-8; -*- -;; Copyright (C) 2000-2012 Free Software Foundation, Inc. +;; Copyright (C) 2000-2012 Free Software Foundation, Inc. ;; Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, ;; 2005, 2006, 2007, 2008, 2009, 2010, 2011 ;; National Institute of Advanced Industrial Science and Technology (AIST) @@ -257,7 +257,11 @@ positions (integers or markers) specifying the region." (define-minor-mode thai-word-mode "Minor mode to make word-oriented commands aware of Thai words. -The commands affected are \\[forward-word], \\[backward-word], \\[kill-word], \\[backward-kill-word], \\[transpose-words], and \\[fill-paragraph]." +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. The commands affected are +\\[forward-word], \\[backward-word], \\[kill-word], \\[backward-kill-word], +\\[transpose-words], and \\[fill-paragraph]." :global t :group 'mule (cond (thai-word-mode ;; This enables linebreak between Thai characters. diff --git a/lisp/mail/supercite.el b/lisp/mail/supercite.el index c91c4b9fcd..d10b073eb1 100644 --- a/lisp/mail/supercite.el +++ b/lisp/mail/supercite.el @@ -1,6 +1,6 @@ ;;; supercite.el --- minor mode for citing mail and news replies -;; Copyright (C) 1993, 1997, 2001-2012 Free Software Foundation, Inc. +;; Copyright (C) 1993, 1997, 2001-2012 Free Software Foundation, Inc. ;; Author: 1993 Barry A. Warsaw ;; Maintainer: Glenn Morris @@ -1847,8 +1847,7 @@ Note on function names in this list: all functions of the form ;; ====================================================================== ;; published interface to mail and news readers -(define-minor-mode sc-minor-mode - "Supercite minor mode." +(define-minor-mode sc-minor-mode nil :group 'supercite :lighter (" SC" (sc-auto-fill-region-p (":f" (sc-fixup-whitespace-p "w")) diff --git a/lisp/minibuffer.el b/lisp/minibuffer.el index 3d9b30bcbb..cb2f2d7638 100644 --- a/lisp/minibuffer.el +++ b/lisp/minibuffer.el @@ -1515,7 +1515,10 @@ exit." ;; (defalias 'completion-in-region--prech 'completion-in-region--postch) (define-minor-mode completion-in-region-mode - "Transient minor mode used during `completion-in-region'." + "Transient minor mode used during `completion-in-region'. +With a prefix argument ARG, enable the modemode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil." :global t (setq completion-in-region--data nil) ;; (remove-hook 'pre-command-hook #'completion-in-region--prech) diff --git a/lisp/net/goto-addr.el b/lisp/net/goto-addr.el index f95381fa80..e5fe45b5bf 100644 --- a/lisp/net/goto-addr.el +++ b/lisp/net/goto-addr.el @@ -275,7 +275,10 @@ Also fontifies the buffer appropriately (see `goto-address-fontify-p' and ;;;###autoload (define-minor-mode goto-address-mode - "Minor mode to buttonize URLs and e-mail addresses in the current buffer." + "Minor mode to buttonize URLs and e-mail addresses in the current buffer. +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." nil "" nil diff --git a/lisp/net/rcirc.el b/lisp/net/rcirc.el index 771c9839cc..b8bf270d87 100644 --- a/lisp/net/rcirc.el +++ b/lisp/net/rcirc.el @@ -1,6 +1,6 @@ ;;; rcirc.el --- default, simple IRC client. -;; Copyright (C) 2005-2012 Free Software Foundation, Inc. +;; Copyright (C) 2005-2012 Free Software Foundation, Inc. ;; Author: Ryan Yeske ;; Maintainers: Ryan Yeske , @@ -1261,7 +1261,10 @@ Create the buffer if it doesn't exist." "Keymap for multiline mode in rcirc.") (define-minor-mode rcirc-multiline-minor-mode - "Minor mode for editing multiple lines in rcirc." + "Minor mode for editing multiple lines in rcirc. +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." :init-value nil :lighter " rcirc-mline" :keymap rcirc-multiline-minor-mode-map @@ -1779,7 +1782,10 @@ This function does not alter the INPUT string." ;;;###autoload (define-minor-mode rcirc-track-minor-mode - "Global minor mode for tracking activity in rcirc buffers." + "Global minor mode for tracking activity in rcirc buffers. +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." :init-value nil :lighter "" :keymap rcirc-track-minor-mode-map diff --git a/lisp/progmodes/cwarn.el b/lisp/progmodes/cwarn.el index 70c5b45ca4..74ca5a6d76 100644 --- a/lisp/progmodes/cwarn.el +++ b/lisp/progmodes/cwarn.el @@ -1,6 +1,6 @@ ;;; cwarn.el --- highlight suspicious C and C++ constructions -;; Copyright (C) 1999-2012 Free Software Foundation, Inc. +;; Copyright (C) 1999-2012 Free Software Foundation, Inc. ;; Author: Anders Lindgren ;; Keywords: c, languages, faces @@ -191,7 +191,9 @@ Note, in addition to enabling this minor mode, the major mode must be included in the variable `cwarn-configuration'. By default C and C++ modes are included. -With ARG, turn CWarn mode on if and only if arg is positive." +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." :group 'cwarn :lighter cwarn-mode-text (cwarn-font-lock-keywords cwarn-mode) (if font-lock-mode (font-lock-fontify-buffer))) diff --git a/lisp/progmodes/flymake.el b/lisp/progmodes/flymake.el index fee45fcb3e..07393c6954 100644 --- a/lisp/progmodes/flymake.el +++ b/lisp/progmodes/flymake.el @@ -1,6 +1,6 @@ ;;; flymake.el -- a universal on-the-fly syntax checker -;; Copyright (C) 2003-2012 Free Software Foundation, Inc. +;; Copyright (C) 2003-2012 Free Software Foundation, Inc. ;; Author: Pavel Kobyakov ;; Maintainer: Pavel Kobyakov @@ -1331,9 +1331,10 @@ For the format of LINE-ERR-INFO, see `flymake-ler-make-ler'." ;;;###autoload (define-minor-mode flymake-mode - "Minor mode to do on-the-fly syntax checking. -When called interactively, toggles the minor mode. -With arg, turn Flymake mode on if and only if arg is positive." + "Toggle on-the-fly syntax checking. +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." :group 'flymake :lighter flymake-mode-line (cond diff --git a/lisp/progmodes/glasses.el b/lisp/progmodes/glasses.el index fb0489f185..b49739a94d 100644 --- a/lisp/progmodes/glasses.el +++ b/lisp/progmodes/glasses.el @@ -1,6 +1,6 @@ ;;; glasses.el --- make cantReadThis readable -;; Copyright (C) 1999-2012 Free Software Foundation, Inc. +;; Copyright (C) 1999-2012 Free Software Foundation, Inc. ;; Author: Milan Zamazal ;; Maintainer: Milan Zamazal @@ -316,8 +316,10 @@ recognized according to the current value of the variable `glasses-separator'." ;;;###autoload (define-minor-mode glasses-mode "Minor mode for making identifiers likeThis readable. -When this mode is active, it tries to add virtual separators (like underscores) -at places they belong to." +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 this mode is active, it tries to +add virtual separators (like underscores) at places they belong to." :group 'glasses :lighter " o^o" (save-excursion (save-restriction diff --git a/lisp/progmodes/hideshow.el b/lisp/progmodes/hideshow.el index 0884d28ad5..104a8f9672 100644 --- a/lisp/progmodes/hideshow.el +++ b/lisp/progmodes/hideshow.el @@ -1,6 +1,6 @@ ;;; hideshow.el --- minor mode cmds to selectively display code/comment blocks -;; Copyright (C) 1994-2012 Free Software Foundation, Inc. +;; Copyright (C) 1994-2012 Free Software Foundation, Inc. ;; Author: Thien-Thi Nguyen ;; Dan Nicolaescu @@ -928,6 +928,10 @@ This can be useful if you have huge RCS logs in those comments." ;;;###autoload (define-minor-mode hs-minor-mode "Minor mode to selectively hide/show code and comment blocks. +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 hideshow minor mode is on, the menu bar is augmented with hideshow commands and the hideshow commands are enabled. The value '(hs . t) is added to `buffer-invisibility-spec'. diff --git a/lisp/progmodes/pascal.el b/lisp/progmodes/pascal.el index db15e3c6f2..95f1adec40 100644 --- a/lisp/progmodes/pascal.el +++ b/lisp/progmodes/pascal.el @@ -1,6 +1,6 @@ ;;; pascal.el --- major mode for editing pascal source in Emacs -*- lexical-binding: t -*- -;; Copyright (C) 1993-2012 Free Software Foundation, Inc. +;; Copyright (C) 1993-2012 Free Software Foundation, Inc. ;; Author: Espen Skoglund ;; Keywords: languages @@ -1394,8 +1394,12 @@ The default is a name found in the buffer around point." (define-obsolete-function-alias 'pascal-outline 'pascal-outline-mode "22.1") (define-minor-mode pascal-outline-mode "Outline-line minor mode for Pascal mode. -When in Pascal Outline mode, portions -of the text being edited may be made invisible. \\ +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 enabled, portions of the text being edited may be made +invisible. \\ Pascal Outline mode provides some additional commands. diff --git a/lisp/scroll-lock.el b/lisp/scroll-lock.el index 87c9842063..c5c19c046f 100644 --- a/lisp/scroll-lock.el +++ b/lisp/scroll-lock.el @@ -49,10 +49,12 @@ ;;;###autoload (define-minor-mode scroll-lock-mode "Buffer-local minor mode for pager-like scrolling. -Keys which normally move point by line or paragraph will scroll -the buffer by the respective amount of lines instead and point -will be kept vertically fixed relative to window boundaries -during scrolling." +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 enabled, keys that normally move +point by line or paragraph will scroll the buffer by the +respective amount of lines instead and point will be kept +vertically fixed relative to window boundaries during scrolling." :lighter " ScrLck" :keymap scroll-lock-mode-map (if scroll-lock-mode diff --git a/lisp/simple.el b/lisp/simple.el index 610d4a3be4..881b0b2207 100644 --- a/lisp/simple.el +++ b/lisp/simple.el @@ -321,9 +321,11 @@ select the source buffer." (define-minor-mode next-error-follow-minor-mode "Minor mode for compilation, occur and diff modes. +With a prefix argument ARG, enable mode if ARG is positive, and +disable it otherwise. If called from Lisp, enable mode if ARG is +omitted or nil. When turned on, cursor motion in the compilation, grep, occur or diff -buffer causes automatic display of the corresponding source code -location." +buffer causes automatic display of the corresponding source code location." :group 'next-error :init-value nil :lighter " Fol" (if (not next-error-follow-minor-mode) (remove-hook 'post-command-hook 'next-error-follow-mode-post-command-hook t) diff --git a/lisp/tar-mode.el b/lisp/tar-mode.el index cb41e6af62..949ac4c088 100644 --- a/lisp/tar-mode.el +++ b/lisp/tar-mode.el @@ -1,6 +1,6 @@ ;;; tar-mode.el --- simple editing of tar files from GNU Emacs -;; Copyright (C) 1990-1991, 1993-2012 Free Software Foundation, Inc. +;; Copyright (C) 1990-1991, 1993-2012 Free Software Foundation, Inc. ;; Author: Jamie Zawinski ;; Maintainer: FSF @@ -677,9 +677,12 @@ See also: variables `tar-update-datestamp' and `tar-anal-blocksize'. (define-minor-mode tar-subfile-mode "Minor mode for editing an element of a tar-file. -This mode arranges for \"saving\" this buffer to write the data -into the tar-file buffer that it came from. The changes will actually -appear on disk when you save the tar-file's buffer." +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. This mode arranges for \"saving\" this +buffer to write the data into the tar-file buffer that it came +from. The changes will actually appear on disk when you save the +tar-file's buffer." ;; Don't do this, because it is redundant and wastes mode line space. ;; :lighter " TarFile" nil nil nil diff --git a/lisp/textmodes/enriched.el b/lisp/textmodes/enriched.el index 14e6014c27..68a99b0efe 100644 --- a/lisp/textmodes/enriched.el +++ b/lisp/textmodes/enriched.el @@ -1,6 +1,6 @@ ;;; enriched.el --- read and save files in text/enriched format -;; Copyright (C) 1994-1996, 2001-2012 Free Software Foundation, Inc. +;; Copyright (C) 1994-1996, 2001-2012 Free Software Foundation, Inc. ;; Author: Boris Goldowsky ;; Keywords: wp, faces @@ -191,6 +191,11 @@ The value is a list of \(VAR VALUE VAR VALUE...).") "Minor mode for editing text/enriched files. These are files with embedded formatting information in the MIME standard text/enriched format. + +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. + Turning the mode on or off runs `enriched-mode-hook'. More information about Enriched mode is available in the file diff --git a/lisp/tooltip.el b/lisp/tooltip.el index 50ae682d42..1fab25fe5c 100644 --- a/lisp/tooltip.el +++ b/lisp/tooltip.el @@ -40,7 +40,9 @@ (define-minor-mode tooltip-mode "Toggle Tooltip mode. -With ARG, turn Tooltip mode on if and only if ARG is positive. +With a prefix argument ARG, enable Tooltip mode if ARG is positive, +and disable it otherwise. If called from Lisp, enable the mode +if ARG is omitted or nil. When this global minor mode is enabled, Emacs displays help text (e.g. for buttons and menu items that you put the mouse on) diff --git a/lisp/url/url-dired.el b/lisp/url/url-dired.el index 72ada79505..f04e7901ef 100644 --- a/lisp/url/url-dired.el +++ b/lisp/url/url-dired.el @@ -43,7 +43,10 @@ (url-dired-find-file)) (define-minor-mode url-dired-minor-mode - "Minor mode for directory browsing." + "Minor mode for directory browsing. +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." :lighter " URL" :keymap url-dired-minor-mode-map) (defun url-find-file-dired (dir) diff --git a/lisp/vc/smerge-mode.el b/lisp/vc/smerge-mode.el index 870246103a..d2881b40ad 100644 --- a/lisp/vc/smerge-mode.el +++ b/lisp/vc/smerge-mode.el @@ -1266,6 +1266,9 @@ with a \\[universal-argument] prefix, makes up a 3-way conflict." ;;;###autoload (define-minor-mode smerge-mode "Minor mode to simplify editing output from the diff3 program. +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. \\{smerge-mode-map}" :group 'smerge :lighter " SMerge" (when (and (boundp 'font-lock-mode) font-lock-mode) diff --git a/lisp/vcursor.el b/lisp/vcursor.el index e0741dcd72..95928ebe87 100644 --- a/lisp/vcursor.el +++ b/lisp/vcursor.el @@ -813,6 +813,8 @@ out how much to copy." (define-minor-mode vcursor-use-vcursor-map "Toggle the state of the vcursor key map. +With a prefix argument ARG, enable it if ARG is positive, and disable +it otherwise. If called from Lisp, enable it if ARG is omitted or nil. When on, the keys defined in it are mapped directly on top of the main keymap, allowing you to move the vcursor with ordinary motion keys. An indication \"!VC\" appears in the mode list. The effect is diff --git a/lisp/wid-browse.el b/lisp/wid-browse.el index 4650548d6e..005e87a6da 100644 --- a/lisp/wid-browse.el +++ b/lisp/wid-browse.el @@ -270,7 +270,10 @@ VALUE is assumed to be a list of widgets." ;;;###autoload (define-minor-mode widget-minor-mode - "Minor mode for traversing widgets." + "Minor mode for traversing widgets. +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." :lighter " Widget") ;;; The End: