Mercurial > emacs

--- a/lisp/ChangeLog	Fri Nov 21 07:40:09 2008 +0000
+++ b/lisp/ChangeLog	Fri Nov 21 10:12:57 2008 +0000
@@ -1,7 +1,27 @@
+2008-11-21  Juanma Barranquero  <lekktu@gmail.com>
+
+	* isearch.el (isearch-search-string): Doc fix.
+	(search-exit-option, search-slow-window-lines, search-slow-speed)
+	(search-upper-case, search-nonincremental-instead)
+	(search-whitespace-regexp, search-ring-max, regexp-search-ring-max)
+	(search-ring-update, search-highlight, isearch-lazy-highlight)
+	(lazy-highlight-cleanup, lazy-highlight-initial-delay)
+	(lazy-highlight-interval): Remove * from defcustom docstrings.
+	(isearch-resume-in-command-history, lazy-highlight-max-at-a-time):
+	Remove * from defcustom docstrings; fix typos.
+	(isearch-push-state-function, isearch-help-for-help-internal)
+	(isearch-help-for-help, isearch-describe-bindings)
+	(isearch-describe-mode, minibuffer-local-isearch-map, isearch-mode)
+	(isearch-pop-fun-state, isearch-search-fun-function)
+	(isearch-lazy-highlight-search): Fix typos in docstrings.
+	(isearch-yank-internal, isearch-fallback): Reflow docstrings.
+	(isearch-forward): Fix typo and reflow docstring.
+	(isearch-help-map): Remove unused `i' binding.  Fix typos in docstring.
+	(isearch-mode-map): Don't use `let*'.
+
 2008-11-21  Chong Yidong  <cyd@stupidchicken.com>

-	* files.el (confirm-nonexistent-file-or-buffer): Change default to
-	nil.
+	* files.el (confirm-nonexistent-file-or-buffer): Change default to nil.

 2008-11-21  Stefan Monnier  <monnier@iro.umontreal.ca>
--- a/lisp/isearch.el	Fri Nov 21 07:40:09 2008 +0000
+++ b/lisp/isearch.el	Fri Nov 21 10:12:57 2008 +0000
@@ -70,12 +70,12 @@


 (defcustom search-exit-option t
-  "*Non-nil means random control characters terminate incremental search."
+  "Non-nil means random control characters terminate incremental search."
   :type 'boolean
   :group 'isearch)

 (defcustom search-slow-window-lines 1
-  "*Number of lines in slow search display windows.
+  "Number of lines in slow search display windows.
 These are the short windows used during incremental search on slow terminals.
 Negative means put the slow search window at the top (normally it's at bottom)
 and the value is minus the number of lines."
@@ -83,14 +83,14 @@
   :group 'isearch)

 (defcustom search-slow-speed 1200
-  "*Highest terminal speed at which to use \"slow\" style incremental search.
+  "Highest terminal speed at which to use \"slow\" style incremental search.
 This is the style where a one-line window is created to show the line
 that the search has reached."
   :type 'integer
   :group 'isearch)

 (defcustom search-upper-case 'not-yanks
-  "*If non-nil, upper case chars disable case fold searching.
+  "If non-nil, upper case chars disable case fold searching.
 That is, upper and lower case chars must match exactly.
 This applies no matter where the chars come from, but does not
 apply to chars in regexps that are prefixed with `\\'.
@@ -102,14 +102,14 @@
   :group 'isearch)

 (defcustom search-nonincremental-instead t
-  "*If non-nil, do a nonincremental search instead if exiting immediately.
+  "If non-nil, do a nonincremental search instead if exiting immediately.
 Actually, `isearch-edit-string' is called to let you enter the search
 string, and RET terminates editing and does a nonincremental search."
   :type 'boolean
   :group 'isearch)

 (defcustom search-whitespace-regexp "\\s-+"
-  "*If non-nil, regular expression to match a sequence of whitespace chars.
+  "If non-nil, regular expression to match a sequence of whitespace chars.
 This applies to regular expression incremental search.
 When you put a space or spaces in the incremental regexp, it stands for
 this, unless it is inside of a regexp construct such as [...] or *, + or ?.
@@ -146,8 +146,8 @@
   :group 'isearch)

 (defcustom isearch-resume-in-command-history nil
-  "*If non-nil, `isearch-resume' commands are added to the command history.
-This allows you to resume earlier isearch sessions through the
+  "If non-nil, `isearch-resume' commands are added to the command history.
+This allows you to resume earlier Isearch sessions through the
 command history."
   :type 'boolean
   :group 'isearch)
@@ -173,7 +173,7 @@
 or to the end of the buffer for a backward search.")

 (defvar isearch-push-state-function nil
-  "Function to save a function restoring the mode-specific isearch state
+  "Function to save a function restoring the mode-specific Isearch state
 to the search status stack.")

 (defvar isearch-filter-predicate 'isearch-filter-invisible
@@ -191,11 +191,11 @@
   "List of regular expression search string sequences.")

 (defcustom search-ring-max 16
-  "*Maximum length of search ring before oldest elements are thrown away."
+  "Maximum length of search ring before oldest elements are thrown away."
   :type 'integer
   :group 'isearch)
 (defcustom regexp-search-ring-max 16
-  "*Maximum length of regexp search ring before oldest elements are thrown away."
+  "Maximum length of regexp search ring before oldest elements are thrown away."
   :type 'integer
   :group 'isearch)

@@ -207,7 +207,7 @@
 It is nil if none yet.")

 (defcustom search-ring-update nil
-  "*Non-nil if advancing or retreating in the search ring should cause search.
+  "Non-nil if advancing or retreating in the search ring should cause search.
 Default value, nil, means edit the string instead."
   :type 'boolean
   :group 'isearch)
@@ -215,7 +215,7 @@
 ;;; isearch highlight customization.

 (defcustom search-highlight t
-  "*Non-nil means incremental search highlights the current match."
+  "Non-nil means incremental search highlights the current match."
   :type 'boolean
   :group 'isearch)

@@ -253,7 +253,7 @@
   :group 'isearch)

 (defcustom isearch-lazy-highlight t
-  "*Controls the lazy-highlighting during incremental search.
+  "Controls the lazy-highlighting during incremental search.
 When non-nil, all text in the buffer matching the current search
 string is highlighted lazily (see `lazy-highlight-initial-delay'
 and `lazy-highlight-interval')."
@@ -271,7 +271,7 @@
   :group 'matching)

 (defcustom lazy-highlight-cleanup t
-  "*Controls whether to remove extra highlighting after a search.
+  "Controls whether to remove extra highlighting after a search.
 If this is nil, extra highlighting can be \"manually\" removed with
 \\[lazy-highlight-cleanup]."
   :type 'boolean
@@ -281,7 +281,7 @@
                                 "22.1")

 (defcustom lazy-highlight-initial-delay 0.25
-  "*Seconds to wait before beginning to lazily highlight all matches."
+  "Seconds to wait before beginning to lazily highlight all matches."
   :type 'number
   :group 'lazy-highlight)
 (define-obsolete-variable-alias 'isearch-lazy-highlight-initial-delay
@@ -289,7 +289,7 @@
                                 "22.1")

 (defcustom lazy-highlight-interval 0 ; 0.0625
-  "*Seconds between lazily highlighting successive matches."
+  "Seconds between lazily highlighting successive matches."
   :type 'number
   :group 'lazy-highlight)
 (define-obsolete-variable-alias 'isearch-lazy-highlight-interval
@@ -297,8 +297,8 @@
                                 "22.1")

 (defcustom lazy-highlight-max-at-a-time 20
-  "*Maximum matches to highlight at a time (for `lazy-highlight').
-Larger values may reduce isearch's responsiveness to user input;
+  "Maximum matches to highlight at a time (for `lazy-highlight').
+Larger values may reduce Isearch's responsiveness to user input;
 smaller values make matches highlight slowly.
 A value of nil means highlight all matches."
   :type '(choice (const :tag "All" nil)
@@ -330,8 +330,7 @@
 ;; Define isearch help map.

 (defvar isearch-help-map
-  (let ((i 0)
-	(map (make-sparse-keymap)))
+  (let ((map (make-sparse-keymap)))
     (define-key map [t] 'isearch-other-control-char)
     (define-key map (char-to-string help-char) 'isearch-help-for-help)
     (define-key map [help] 'isearch-help-for-help)
@@ -342,7 +341,7 @@
     (define-key map "m" 'isearch-describe-mode)
     (define-key map "q" 'help-quit)
     map)
-  "Keymap for characters following the Help key for isearch mode.")
+  "Keymap for characters following the Help key for Isearch mode.")

 (eval-when-compile (require 'help-macro))

@@ -351,25 +350,25 @@
   "You have typed %THIS-KEY%, the help character.  Type a Help option:
 \(Type \\<help-map>\\[help-quit] to exit the Help command.)

-b           Display all isearch key bindings.
-k KEYS      Display full documentation of isearch key sequence.
-m           Display documentation of isearch mode.
+b           Display all Isearch key bindings.
+k KEYS      Display full documentation of Isearch key sequence.
+m           Display documentation of Isearch mode.

 You can't type here other help keys available in the global help map,
-but outise of this help window when you type them in isearch mode,
-they exit isearch mode before displaying global help."
+but outside of this help window when you type them in Isearch mode,
+they exit Isearch mode before displaying global help."
   isearch-help-map)

 (defun isearch-help-for-help ()
-  "Display isearch help menu."
+  "Display Isearch help menu."
   (interactive)
   (let (same-window-buffer-names same-window-regexps)
     (isearch-help-for-help-internal))
   (isearch-update))

 (defun isearch-describe-bindings ()
-  "Show a list of all keys defined in isearch mode, and their definitions.
-This is like `describe-bindings', but displays only isearch keys."
+  "Show a list of all keys defined in Isearch mode, and their definitions.
+This is like `describe-bindings', but displays only Isearch keys."
   (interactive)
   (let (same-window-buffer-names same-window-regexps)
     (with-help-window "*Help*"
@@ -385,7 +384,7 @@
   (isearch-update))

 (defun isearch-describe-mode ()
-  "Display documentation of isearch mode."
+  "Display documentation of Isearch mode."
   (interactive)
   (let (same-window-buffer-names same-window-regexps)
     (describe-function 'isearch-forward))
@@ -397,8 +396,8 @@
 ;; Define isearch-mode keymap.

 (defvar isearch-mode-map
-  (let* ((i 0)
-	 (map (make-keymap)))
+  (let ((i 0)
+	(map (make-keymap)))
     (or (char-table-p (nth 1 map))
 	(error "The initialization of isearch-mode-map must be updated"))
     ;; Make all multibyte characters search for themselves.
@@ -514,7 +513,7 @@
     (define-key map "\C-f"  'isearch-yank-char-in-minibuffer)
     (define-key map [right] 'isearch-yank-char-in-minibuffer)
     map)
-  "Keymap for editing isearch strings in the minibuffer.")
+  "Keymap for editing Isearch strings in the minibuffer.")

 ;; Internal variables declared globally for byte-compiler.
 ;; These are all set with setq while isearching
@@ -659,18 +658,19 @@
 Type \\[isearch-highlight-regexp] to run `highlight-regexp'\
  that highlights the last search string.

-Type \\[isearch-describe-bindings] to display all isearch key bindings.
-Type \\[isearch-describe-key] to display documentation of isearch key.
-Type \\[isearch-describe-mode] to display documentation of isearch mode.
+Type \\[isearch-describe-bindings] to display all Isearch key bindings.
+Type \\[isearch-describe-key] to display documentation of Isearch key.
+Type \\[isearch-describe-mode] to display documentation of Isearch mode.

 If an input method is turned on in the current buffer, that input
-method is also active while you are typing characters to search.  To
-toggle the input method, type \\[isearch-toggle-input-method].  It
-also toggles the input method in the current buffer.
+method is also active while you are typing characters to search.
+To toggle the input method, type \\[isearch-toggle-input-method].  \
+It also toggles the input
+method in the current buffer.

-To use a different input method for searching, type
-\\[isearch-toggle-specified-input-method], and specify an input method
-you want to use.
+To use a different input method for searching, type \
+\\[isearch-toggle-specified-input-method],
+and specify an input method you want to use.

 The above keys, bound in `isearch-mode-map', are often controlled by
  options; do \\[apropos] on search-.* to find them.
@@ -736,7 +736,7 @@


 (defun isearch-mode (forward &optional regexp op-fun recursive-edit word-p)
-  "Start isearch minor mode.
+  "Start Isearch minor mode.
 It is called by the function `isearch-forward' and other related functions."

   ;; Initialize global vars.
@@ -994,7 +994,7 @@
   "Return the case-folding flag in FRAME."
   (aref frame 10))
 (defsubst isearch-pop-fun-state (frame)
-  "Return the function restoring the mode-specific isearch state in FRAME."
+  "Return the function restoring the mode-specific Isearch state in FRAME."
   (aref frame 11))

 (defun isearch-top-state ()
@@ -1512,10 +1512,10 @@

 (defun isearch-yank-internal (jumpform)
   "Pull the text from point to the point reached by JUMPFORM.
-JUMPFORM is a lambda expression that takes no arguments and returns a
-buffer position, possibly having moved point to that position.  For
-example, it might move point forward by a word and return point, or it
-might return the position of the end of the line."
+JUMPFORM is a lambda expression that takes no arguments and returns
+a buffer position, possibly having moved point to that position.
+For example, it might move point forward by a word and return point,
+or it might return the position of the end of the line."
   (isearch-yank-string
    (save-excursion
      (and (not isearch-forward) isearch-other-end
@@ -1619,7 +1619,7 @@
 (defun isearch-fallback (want-backslash &optional allow-invalid to-barrier)
   "Return point to previous successful match to allow regexp liberalization.
 \\<isearch-mode-map>
-Respects \\[isearch-repeat-forward] and \\[isearch-repeat-backward] by
+Respects \\[isearch-repeat-forward] and \\[isearch-repeat-backward] by \
 stopping at `isearch-barrier' as needed.

 Do nothing if a backslash is escaping the liberalizing character.
@@ -2189,7 +2189,7 @@

 (defvar isearch-search-fun-function nil
   "Override `isearch-search-fun'.
-This function should return the search function for isearch to use.
+This function should return the search function for Isearch to use.
 It will call this function with three arguments
 as if it were `search-forward'.")

@@ -2212,9 +2212,9 @@
       (if isearch-forward 'search-forward 'search-backward)))))

 (defun isearch-search-string (string bound noerror)
-  "Search for the first occurance of STRING or its translation.  If
-found, move point to the end of the occurance, update
-isearch-match-beg and isearch-match-end, and return point."
+  "Search for the first occurrence of STRING or its translation.
+If found, move point to the end of the occurrence,
+update the match data, and return point."
   (let* ((func (isearch-search-fun))
          (pos1 (save-excursion (funcall func string bound noerror)))
          pos2)
@@ -2623,7 +2623,7 @@

 (defun isearch-lazy-highlight-search ()
   "Search ahead for the next or previous match, for lazy highlighting.
-Attempt to do the search exactly the way the pending isearch would."
+Attempt to do the search exactly the way the pending Isearch would."
   (condition-case nil
       (let ((case-fold-search isearch-lazy-highlight-case-fold-search)
 	    (isearch-regexp isearch-lazy-highlight-regexp)