Mercurial > emacs
changeset 99257:1fbe0f0007b7
* simple.el (idle-update-delay, next-error-highlight)
(next-error-highlight-no-select, next-error-recenter, next-error-hook)
(minibuffer-history-case-insensitive-variables, kill-ring-max)
(kill-read-only-ok, backward-delete-char-untabify-method)
(kill-whole-line, mark-ring-max, global-mark-ring-max)
(set-mark-command-repeat-pop, next-line-add-newlines, track-eol)
(goal-column, line-move-ignore-invisible, fill-prefix)
(auto-fill-inhibit-regexp, blink-matching-paren)
(blink-matching-paren-on-screen, blink-matching-paren-distance)
(blink-matching-delay, blink-matching-paren-dont-ignore-comments)
(read-mail-command, mail-user-agent): Remove * in defcustom docstrings.
(minibuffer-history-isearch-wrap, transient-mark-mode)
(next-logical-line, auto-fill-mode, line-number-mode)
(column-number-mode, size-indication-mode, clone-indirect-buffer)
(normal-erase-is-backspace-mode): Doc fixes.
(current-kill, transient-mark-mode, toggle-truncate-lines)
(visible-mode): Reflow docstrings.
(minibuffer-local-shell-command-map, interprogram-paste-function):
Fix typos in docstrings.
author | Juanma Barranquero <lekktu@gmail.com> |
---|---|
date | Thu, 30 Oct 2008 17:03:30 +0000 |
parents | c1068d553a51 |
children | 84b8aa5bf9a5 |
files | lisp/ChangeLog lisp/simple.el |
diffstat | 2 files changed, 74 insertions(+), 53 deletions(-) [+] |
line wrap: on
line diff
--- a/lisp/ChangeLog Thu Oct 30 15:59:50 2008 +0000 +++ b/lisp/ChangeLog Thu Oct 30 17:03:30 2008 +0000 @@ -1,3 +1,25 @@ +2008-10-30 Juanma Barranquero <lekktu@gmail.com> + + * simple.el (idle-update-delay, next-error-highlight) + (next-error-highlight-no-select, next-error-recenter, next-error-hook) + (minibuffer-history-case-insensitive-variables, kill-ring-max) + (kill-read-only-ok, backward-delete-char-untabify-method) + (kill-whole-line, mark-ring-max, global-mark-ring-max) + (set-mark-command-repeat-pop, next-line-add-newlines, track-eol) + (goal-column, line-move-ignore-invisible, fill-prefix) + (auto-fill-inhibit-regexp, blink-matching-paren) + (blink-matching-paren-on-screen, blink-matching-paren-distance) + (blink-matching-delay, blink-matching-paren-dont-ignore-comments) + (read-mail-command, mail-user-agent): Remove * in defcustom docstrings. + (minibuffer-history-isearch-wrap, transient-mark-mode) + (next-logical-line, auto-fill-mode, line-number-mode) + (column-number-mode, size-indication-mode, clone-indirect-buffer) + (normal-erase-is-backspace-mode): Doc fixes. + (current-kill, transient-mark-mode, toggle-truncate-lines) + (visible-mode): Reflow docstrings. + (minibuffer-local-shell-command-map, interprogram-paste-function): + Fix typos in docstrings. + 2008-10-30 Chong Yidong <cyd@stupidchicken.com> * server.el (server-process-filter): In daemon mode, default to @@ -29,8 +51,7 @@ * minibuffer.el (delete-minibuffer-contents): Delete all minibuffer contents instead of just the current field. - * tmm.el (tmm-get-keymap): Handle case where keyseq cache is - omitted. + * tmm.el (tmm-get-keymap): Handle case where keyseq cache is omitted. * bookmark.el (bookmark-handle-bookmark): Rename from bookmark-jump-noselect.
--- a/lisp/simple.el Thu Oct 30 15:59:50 2008 +0000 +++ b/lisp/simple.el Thu Oct 30 17:03:30 2008 +0000 @@ -38,7 +38,7 @@ (defvar compilation-current-error) (defcustom idle-update-delay 0.5 - "*Idle time delay before updating various things on the screen. + "Idle time delay before updating various things on the screen. Various Emacs features that update auxiliary information when point moves wait this many seconds after Emacs becomes idle before doing an update." :type 'number @@ -118,7 +118,7 @@ :version "22.1") (defcustom next-error-highlight 0.5 - "*Highlighting of locations in selected source buffers. + "Highlighting of locations in selected source buffers. If a number, highlight the locus in `next-error' face for the given time in seconds, or until the next command is executed. If t, highlight the locus until the next command is executed, or until @@ -133,7 +133,7 @@ :version "22.1") (defcustom next-error-highlight-no-select 0.5 - "*Highlighting of locations in `next-error-no-select'. + "Highlighting of locations in `next-error-no-select'. If number, highlight the locus in `next-error' face for given time in seconds. If t, highlight the locus indefinitely until some other locus replaces it. If nil, don't highlight the locus in the source buffer. @@ -146,7 +146,7 @@ :version "22.1") (defcustom next-error-recenter nil - "*Display the line in the visited source file recentered as specified. + "Display the line in the visited source file recentered as specified. If non-nil, the value is passed directly to `recenter'." :type '(choice (integer :tag "Line to recenter to") (const :tag "Center of window" (4)) @@ -155,7 +155,7 @@ :version "23.1") (defcustom next-error-hook nil - "*List of hook functions run by `next-error' after visiting source file." + "List of hook functions run by `next-error' after visiting source file." :type 'hook :group 'next-error) @@ -407,7 +407,7 @@ (define-key map "<" 'beginning-of-buffer) (define-key map "g" 'revert-buffer) map)) - + (put 'special-mode 'mode-class 'special) (define-derived-mode special-mode nil "Special" "Parent major mode from which special major modes should inherit." @@ -1216,7 +1216,7 @@ (constrain-to-field nil (point-max))) (defcustom minibuffer-history-case-insensitive-variables nil - "*Minibuffer history variables for which matching should ignore case. + "Minibuffer history variables for which matching should ignore case. If a history variable is a member of this list, then the \\[previous-matching-history-element] and \\[next-matching-history-element]\ commands ignore case when searching it, regardless of `case-fold-search'." @@ -1559,7 +1559,7 @@ (message ""))) (defun minibuffer-history-isearch-wrap () - "Wrap the minibuffer history search when search is failed. + "Wrap the minibuffer history search when search fails. Move point to the first history element for a forward search, or to the last history element for a backward search." (unless isearch-word @@ -2018,7 +2018,7 @@ (set-keymap-parent map minibuffer-local-map) (define-key map "\t" 'minibuffer-complete-shell-command) map) - "Keymap used for completiing shell commands in minibufffer.") + "Keymap used for completing shell commands in minibuffer.") (defun read-shell-command (prompt &optional initial-contents hist &rest args) "Read a shell command from the minibuffer. @@ -2704,7 +2704,7 @@ should put this string in the kill ring as the latest kill. This function may also return a list of strings if the window -system supports multiple selections. The first string will be +system supports multiple selections. The first string will be used as the pasted text, but the other will be placed in the kill ring for easy access via `yank-pop'. @@ -2730,7 +2730,7 @@ ring directly.") (defcustom kill-ring-max 60 - "*Maximum length of kill ring before oldest elements are thrown away." + "Maximum length of kill ring before oldest elements are thrown away." :type 'integer :group 'killing) @@ -2795,10 +2795,10 @@ (defun current-kill (n &optional do-not-move) "Rotate the yanking point by N places, and then return that kill. -If N is zero, `interprogram-paste-function' is set, and calling it returns a -string or list of strings, then that string (or list) is added to the front -of the kill ring and the string (or first string in the list) is returned as -the latest kill. +If N is zero, `interprogram-paste-function' is set, and calling +it returns a string or list of strings, then that string (or +list) is added to the front of the kill ring and the string (or +first string in the list) is returned as the latest kill. If N is not zero, and if `yank-pop-change-selection' is non-nil, use `interprogram-cut-function' to transfer the @@ -2838,7 +2838,7 @@ ;;;; Commands for manipulating the kill ring. (defcustom kill-read-only-ok nil - "*Non-nil means don't signal an error for killing read-only text." + "Non-nil means don't signal an error for killing read-only text." :type 'boolean :group 'killing) @@ -3092,7 +3092,7 @@ (kill-region (point) (forward-point (- arg)))) (defcustom backward-delete-char-untabify-method 'untabify - "*The method for untabifying when deleting backward. + "The method for untabifying when deleting backward. Can be `untabify' -- turn a tab to many spaces, then delete one space; `hungry' -- delete all whitespace, both tabs and spaces; `all' -- delete all whitespace, including tabs, spaces and newlines; @@ -3146,7 +3146,7 @@ ;; kill-line and its subroutines. (defcustom kill-whole-line nil - "*If non-nil, `kill-line' with no arg at beg of line kills the whole line." + "If non-nil, `kill-line' with no arg at beg of line kills the whole line." :type 'boolean :group 'killing) @@ -3529,7 +3529,7 @@ (put 'mark-ring 'permanent-local t) (defcustom mark-ring-max 16 - "*Maximum size of mark ring. Start discarding off end if gets this big." + "Maximum size of mark ring. Start discarding off end if gets this big." :type 'integer :group 'editing-basics) @@ -3537,7 +3537,7 @@ "The list of saved global marks, most recent first.") (defcustom global-mark-ring-max 16 - "*Maximum size of global mark ring. \ + "Maximum size of global mark ring. \ Start discarding off end if gets this big." :type 'integer :group 'editing-basics) @@ -3567,7 +3567,7 @@ (message "Mark activated"))))) (defcustom set-mark-command-repeat-pop nil - "*Non-nil means repeating \\[set-mark-command] after popping mark pops it again. + "Non-nil means repeating \\[set-mark-command] after popping mark pops it again. That means that C-u \\[set-mark-command] \\[set-mark-command] will pop the mark twice, and C-u \\[set-mark-command] \\[set-mark-command] \\[set-mark-command] @@ -3738,7 +3738,7 @@ (define-minor-mode transient-mark-mode "Toggle Transient Mark mode. -With arg, turn Transient Mark mode on if arg is positive, off otherwise. +With ARG, turn Transient Mark mode on if ARG is positive, off otherwise. In Transient Mark mode, when the mark is active, the region is highlighted. Changing the buffer \"deactivates\" the mark. @@ -3771,10 +3771,9 @@ The variable `highlight-nonselected-windows' controls whether to highlight all windows or just the selected window. -If the value is `lambda', that enables Transient Mark mode -temporarily. After any subsequent action that would normally -deactivate the mark (such as buffer modification), Transient Mark mode -is turned off. +If the value is `lambda', that enables Transient Mark mode temporarily. +After any subsequent action that would normally deactivate the mark +\(such as buffer modification), Transient Mark mode is turned off. If the value is (only . OLDVAL), that enables Transient Mark mode temporarily. After any subsequent point motion command that is not @@ -3813,7 +3812,7 @@ (switch-to-buffer buffer))) (defcustom next-line-add-newlines nil - "*If non-nil, `next-line' inserts newline to avoid `end of buffer' error." + "If non-nil, `next-line' inserts newline to avoid `end of buffer' error." :type 'boolean :version "21.1" :group 'editing-basics) @@ -3890,7 +3889,7 @@ nil) (defcustom track-eol nil - "*Non-nil means vertical motion starting at end of line keeps to ends of lines. + "Non-nil means vertical motion starting at end of line keeps to ends of lines. This means moving to the end of each line moved onto. The beginning of a blank line does not count as the end of a line. This has no effect when `line-move-visual' is non-nil." @@ -3898,7 +3897,7 @@ :group 'editing-basics) (defcustom goal-column nil - "*Semipermanent goal column for vertical motion, as set by \\[set-goal-column], or nil." + "Semipermanent goal column for vertical motion, as set by \\[set-goal-column], or nil." :type '(choice integer (const :tag "None" nil)) :group 'editing-basics) @@ -3914,7 +3913,7 @@ `most-positive-fixnum'.") (defcustom line-move-ignore-invisible t - "*Non-nil means \\[next-line] and \\[previous-line] ignore invisible lines. + "Non-nil means \\[next-line] and \\[previous-line] ignore invisible lines. Outline mode sets this." :type 'boolean :group 'editing-basics) @@ -4461,7 +4460,7 @@ (defun next-logical-line (&optional arg try-vscroll) "Move cursor vertically down ARG lines. -This is identical to `previous-line', except that it always moves +This is identical to `next-line', except that it always moves by logical lines instead of visual lines, ignoring the value of the variable `line-move-visual'." (interactive "^p\np") @@ -4806,7 +4805,7 @@ (buffer-substring-no-properties start end))))) (defcustom fill-prefix nil - "*String for filling to insert at front of new line, or nil for none." + "String for filling to insert at front of new line, or nil for none." :type '(choice (const :tag "None" nil) string) :group 'fill) @@ -4814,7 +4813,7 @@ (put 'fill-prefix 'safe-local-variable 'string-or-null-p) (defcustom auto-fill-inhibit-regexp nil - "*Regexp to match lines which should not be auto-filled." + "Regexp to match lines which should not be auto-filled." :type '(choice (const :tag "None" nil) regexp) :group 'fill) @@ -4956,7 +4955,7 @@ ;; Add a global minor mode version of it. (defun auto-fill-mode (&optional arg) "Toggle Auto Fill mode. -With arg, turn Auto Fill mode on if and only if arg is positive. +With ARG, turn Auto Fill mode on if and only if ARG is positive. In Auto Fill mode, inserting a space at a column beyond `current-fill-column' automatically breaks the line at a previous space. @@ -5030,8 +5029,8 @@ (defun toggle-truncate-lines (&optional arg) "Toggle whether to fold or truncate long lines for the current buffer. With prefix argument ARG, truncate long lines if ARG is positive, -otherwise don't truncate them. Note that in side-by-side -windows, this command has no effect if `truncate-partial-width-windows' +otherwise don't truncate them. Note that in side-by-side windows, +this command has no effect if `truncate-partial-width-windows' is non-nil." (interactive "P") (setq truncate-lines @@ -5092,7 +5091,7 @@ (define-minor-mode line-number-mode "Toggle Line Number mode. -With arg, turn Line Number mode on if arg is positive, otherwise +With ARG, turn Line Number mode on if ARG is positive, otherwise turn it off. When Line Number mode is enabled, the line number appears in the mode line. @@ -5103,14 +5102,14 @@ (define-minor-mode column-number-mode "Toggle Column Number mode. -With arg, turn Column Number mode on if arg is positive, +With ARG, turn Column Number mode on if ARG is positive, otherwise turn it off. When Column Number mode is enabled, the column number appears in the mode line." :global t :group 'mode-line) (define-minor-mode size-indication-mode "Toggle Size Indication mode. -With arg, turn Size Indication mode on if arg is positive, +With ARG, turn Size Indication mode on if ARG is positive, otherwise turn it off. When Size Indication mode is enabled, the size of the accessible part of the buffer appears in the mode line." :global t :group 'mode-line) @@ -5121,12 +5120,12 @@ :group 'paren-matching) (defcustom blink-matching-paren t - "*Non-nil means show matching open-paren when close-paren is inserted." + "Non-nil means show matching open-paren when close-paren is inserted." :type 'boolean :group 'paren-blinking) (defcustom blink-matching-paren-on-screen t - "*Non-nil means show matching open-paren when it is on screen. + "Non-nil means show matching open-paren when it is on screen. If nil, don't show it (but the open-paren can still be shown when it is off screen). @@ -5137,18 +5136,18 @@ :group 'paren-blinking) (defcustom blink-matching-paren-distance (* 25 1024) - "*If non-nil, maximum distance to search backwards for matching open-paren. + "If non-nil, maximum distance to search backwards for matching open-paren. If nil, search stops at the beginning of the accessible portion of the buffer." :type '(choice (const nil) integer) :group 'paren-blinking) (defcustom blink-matching-delay 1 - "*Time in seconds to delay after showing a matching paren." + "Time in seconds to delay after showing a matching paren." :type 'number :group 'paren-blinking) (defcustom blink-matching-paren-dont-ignore-comments nil - "*If nil, `blink-matching-paren' ignores comments. + "If nil, `blink-matching-paren' ignores comments. More precisely, when looking for the matching parenthesis, it skips the contents of comments that end before point." :type 'boolean @@ -5251,7 +5250,6 @@ (message "Matches %s" (substring-no-properties open-paren-line-string))))))))) -;; Turned off because it makes dbx bomb out. (setq blink-paren-function 'blink-matching-open) ;; This executes C-g typed while Emacs is waiting for a command. @@ -5312,7 +5310,7 @@ (defcustom read-mail-command 'rmail - "*Your preference for a mail reading package. + "Your preference for a mail reading package. This is used by some keybindings which support reading mail. See also `mail-user-agent' concerning sending mail." :type '(choice (function-item rmail) @@ -5323,7 +5321,7 @@ :group 'mail) (defcustom mail-user-agent 'sendmail-user-agent - "*Your preference for a mail composition package. + "Your preference for a mail composition package. Various Emacs Lisp packages (e.g. Reporter) require you to compose an outgoing email message. This variable lets you specify which mail-sending package you prefer. @@ -6049,7 +6047,9 @@ from the minibuffer when invoked with a prefix arg. If NEWNAME is nil or if not called with a prefix arg, NEWNAME defaults to the current buffer's name. The name is modified by adding a `<N>' suffix to it -or by incrementing the N in an existing suffix. +or by incrementing the N in an existing suffix. Trying to clone a +buffer whose major mode symbol has a non-nil `no-clone-indirect' +property results in an error. DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'. This is always done when called interactively. @@ -6151,7 +6151,7 @@ (defun normal-erase-is-backspace-mode (&optional arg) "Toggle the Erase and Delete mode of the Backspace and Delete keys. -With numeric arg, turn the mode on if and only if ARG is positive. +With numeric ARG, turn the mode on if and only if ARG is positive. On window systems, when this mode is on, Delete is mapped to C-d and Backspace is mapped to DEL; when this mode is off, both @@ -6240,8 +6240,8 @@ turn it off. Enabling Visible mode makes all invisible text temporarily visible. -Disabling Visible mode turns off that effect. Visible mode -works by saving the value of `buffer-invisibility-spec' and setting it to nil." +Disabling Visible mode turns off that effect. Visible mode works by +saving the value of `buffer-invisibility-spec' and setting it to nil." :lighter " Vis" :group 'editing-basics (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)