Commit e1ac4066 authored by Glenn Morris's avatar Glenn Morris
Browse files

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.
parent 5eb7536f
......@@ -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)
......
2012-02-08 Glenn Morris <rgm@gnu.org>
* 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 <eliz@gnu.org>
* ls-lisp.el (ls-lisp-sanitize): New function.
......
......@@ -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])
......
......@@ -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))))
......
......@@ -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
......
......@@ -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)))
......
......@@ -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))
......
......@@ -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
......
......@@ -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))
......
......@@ -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))
......
......@@ -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
......
;;; 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)))
......
;;; 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.
......
;;; 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 <bwarsaw@python.org>
;; Maintainer: Glenn Morris <rgm@gnu.org>
......@@ -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"))
......
......@@ -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)
......
......@@ -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
......
;;; 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 <rcyeske@gmail.com>
;; Maintainers: Ryan Yeske <rcyeske@gmail.com>,
......@@ -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
......
;;; 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 <andersl@andersl.com>
;; 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)))
......
;;; 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 <pk_at_work@yahoo.com>
;; Maintainer: Pavel Kobyakov <pk_at_work@yahoo.com>
......@@ -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
......
;;; glasses.el --- make cantReadThis readable
;; Copyright (C) 1999-2012 Free Software Foundation, Inc.
;; Copyright (C) 1999-2012 Free Software Foundation, Inc.
;; Author: Milan Zamazal <pdm@zamazal.org>
;; Maintainer: Milan Zamazal <pdm@zamazal.org>
......@@ -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
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment