[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Emacs-diffs] trunk r116637: lisp/icomplete.el, lisp/ido.el: Doc fixes.
|
From: |
Juanma Barranquero |
|
Subject: |
[Emacs-diffs] trunk r116637: lisp/icomplete.el, lisp/ido.el: Doc fixes. |
|
Date: |
Mon, 03 Mar 2014 02:27:27 +0000 |
|
User-agent: |
Bazaar (2.6b2) |
------------------------------------------------------------
revno: 116637
revision-id: address@hidden
parent: address@hidden
committer: Juanma Barranquero <address@hidden>
branch nick: trunk
timestamp: Mon 2014-03-03 03:27:08 +0100
message:
lisp/icomplete.el, lisp/ido.el: Doc fixes.
lisp/icomplete.el: Miscellaneous doc fixes.
Use Icomplete everywhere instead of icomplete for consistency.
(icomplete-max-delay-chars): Fix typo.
(icomplete-mode): Use \[].
(icomplete-tidy, icomplete-exhibit): Reflow.
(icomplete-minibuffer-setup-hook, icomplete-completions):
Remove superfluous backlashes.
lisp/ido.el: Miscellaneous doc fixes.
Use Ido everywhere instead of ido or `ido' for consistency.
(ido-record-ftp-work-directories, ido-merge-ftp-work-directories)
(ido-cache-ftp-work-directory-time, ido-slow-ftp-hosts)
(ido-slow-ftp-host-regexps, ido-reread-directory): Upcase "ftp".
(ido-separator): Extract obsolescence info from docstring and declare
with make-obsolete-variable.
(ido-minibuffer-setup-hook): Simplify example.
(ido-text, ido-text-init, ido-input-stack, ido-report-no-match)
(ido-wide-find-file, ido-wide-find-dir, ido-wide-find-dir-or-delete-dir)
(ido-completion-help, ido-completing-read): Fix typos in docstrings.
(ido-everywhere): Reflow docstring.
(ido-toggle-vc): Doc fix.
(ido-switch-buffer, ido-find-file): Use tabs to improve legibility
of long list of keybindings.
modified:
lisp/ChangeLog changelog-20091113204419-o5vbwnq5f7feedwu-1432
lisp/icomplete.el
icomplete.el-20091113204419-o5vbwnq5f7feedwu-643
lisp/ido.el ido.el-20091113204419-o5vbwnq5f7feedwu-2430
=== modified file 'lisp/ChangeLog'
--- a/lisp/ChangeLog 2014-03-03 01:00:27 +0000
+++ b/lisp/ChangeLog 2014-03-03 02:27:08 +0000
@@ -1,3 +1,29 @@
+2014-03-03 Juanma Barranquero <address@hidden>
+
+ * icomplete.el: Miscellaneous doc fixes.
+ Use Icomplete everywhere instead of icomplete for consistency.
+ (icomplete-max-delay-chars): Fix typo.
+ (icomplete-mode): Use \[].
+ (icomplete-tidy, icomplete-exhibit): Reflow.
+ (icomplete-minibuffer-setup-hook, icomplete-completions):
+ Remove superfluous backlashes.
+
+ * ido.el: Miscellaneous doc fixes.
+ Use Ido everywhere instead of ido or `ido' for consistency.
+ (ido-record-ftp-work-directories, ido-merge-ftp-work-directories)
+ (ido-cache-ftp-work-directory-time, ido-slow-ftp-hosts)
+ (ido-slow-ftp-host-regexps, ido-reread-directory): Upcase "ftp".
+ (ido-separator): Extract obsolescence info from docstring and declare
+ with make-obsolete-variable.
+ (ido-minibuffer-setup-hook): Simplify example.
+ (ido-text, ido-text-init, ido-input-stack, ido-report-no-match)
+ (ido-wide-find-file, ido-wide-find-dir, ido-wide-find-dir-or-delete-dir)
+ (ido-completion-help, ido-completing-read): Fix typos in docstrings.
+ (ido-everywhere): Reflow docstring.
+ (ido-toggle-vc): Doc fix.
+ (ido-switch-buffer, ido-find-file): Use tabs to improve legibility
+ of long list of keybindings.
+
2014-03-03 Glenn Morris <address@hidden>
* frame.el (display-pixel-height, display-pixel-width)
=== modified file 'lisp/icomplete.el'
--- a/lisp/icomplete.el 2014-03-02 00:50:07 +0000
+++ b/lisp/icomplete.el 2014-03-03 02:27:08 +0000
@@ -61,7 +61,7 @@
'icomplete-prospects-length 'icomplete-prospects-height "23.1")
(defcustom icomplete-separator " | "
- "String used by icomplete to separate alternatives in the minibuffer."
+ "String used by Icomplete to separate alternatives in the minibuffer."
:type 'string
:version "24.4")
@@ -77,7 +77,7 @@
:version "24.4")
(defcustom icomplete-with-completion-tables t
- "Specialized completion tables with which icomplete should operate.
+ "Specialized completion tables with which Icomplete should operate.
If this is t, Icomplete operates on all tables.
Otherwise this should be a list of the completion tables (e.g.,
`internal-complete-buffer') on which Icomplete should operate."
@@ -87,7 +87,7 @@
(repeat function)))
(defface icomplete-first-match '((t :weight bold))
- "Face used by icomplete for highlighting first match."
+ "Face used by Icomplete for highlighting first match."
:version "24.4")
;;;_* User Customization variables
@@ -109,7 +109,7 @@
:type 'integer)
(defcustom icomplete-max-delay-chars 3
- "Maximum number of initial chars to apply icomplete compute delay."
+ "Maximum number of initial chars to apply `icomplete-compute-delay'."
:type 'integer)
(defvar icomplete-in-buffer nil
@@ -118,12 +118,12 @@
(defcustom icomplete-minibuffer-setup-hook nil
"Icomplete-specific customization of minibuffer setup.
-This hook is run during minibuffer setup if icomplete is active.
-It is intended for use in customizing icomplete for interoperation
+This hook is run during minibuffer setup if Icomplete is active.
+It is intended for use in customizing Icomplete for interoperation
with other features and packages. For instance:
- \(add-hook 'icomplete-minibuffer-setup-hook
- \(lambda () (setq-local max-mini-window-height 3)))
+ (add-hook 'icomplete-minibuffer-setup-hook
+ (lambda () (setq-local max-mini-window-height 3)))
will constrain Emacs to a maximum minibuffer height of 3 lines when
icompletion is occurring."
@@ -197,7 +197,7 @@
description of how prospective completions are displayed.
For more information, see Info node `(emacs)Icomplete'.
-For options you can set, `M-x customize-group icomplete'.
+For options you can set, `\\[customize-group] icomplete'.
You can use the following key bindings to navigate and select
completions:
@@ -295,16 +295,16 @@
;;;_ > icomplete-tidy ()
(defun icomplete-tidy ()
- "Remove completions display \(if any) prior to new user input.
-Should be run in on the minibuffer `pre-command-hook'. See `icomplete-mode'
-and `minibuffer-setup-hook'."
+ "Remove completions display (if any) prior to new user input.
+Should be run in on the minibuffer `pre-command-hook'.
+See `icomplete-mode' and `minibuffer-setup-hook'."
(delete-overlay icomplete-overlay))
;;;_ > icomplete-exhibit ()
(defun icomplete-exhibit ()
- "Insert icomplete completions display.
-Should be run via minibuffer `post-command-hook'. See `icomplete-mode'
-and `minibuffer-setup-hook'."
+ "Insert Icomplete completions display.
+Should be run via minibuffer `post-command-hook'.
+See `icomplete-mode' and `minibuffer-setup-hook'."
(when (and icomplete-mode
(icomplete-simple-completing-p)) ;Shouldn't be necessary.
(save-excursion
@@ -352,17 +352,17 @@
minibuffer completion.
Prospective completion suffixes (if any) are displayed, bracketed by
-one of \(), \[], or \{} pairs. The choice of brackets is as follows:
+one of (), [], or {} pairs. The choice of brackets is as follows:
- \(...) - a single prospect is identified and matching is enforced,
- \[...] - a single prospect is identified but matching is optional, or
- \{...} - multiple prospects, separated by commas, are indicated, and
+ (...) - a single prospect is identified and matching is enforced,
+ [...] - a single prospect is identified but matching is optional, or
+ {...} - multiple prospects, separated by commas, are indicated, and
further input is required to distinguish a single one.
If there are multiple possibilities, `icomplete-separator' separates them.
The displays for unambiguous matches have ` [Matched]' appended
-\(whether complete or not), or ` \[No matches]', if no eligible
+\(whether complete or not), or ` [No matches]', if no eligible
matches exist."
(let* ((minibuffer-completion-table candidates)
(minibuffer-completion-predicate predicate)
=== modified file 'lisp/ido.el'
--- a/lisp/ido.el 2014-02-17 15:29:15 +0000
+++ b/lisp/ido.el 2014-03-03 02:27:08 +0000
@@ -162,7 +162,7 @@
;;
;; The standard way of completion with Unix-shells and Emacs is to insert a
;; PREFIX and then hitting TAB (or another completion key). Cause of this
-;; behavior has become second nature to a lot of Emacs users `ido' offers in
+;; behavior has become second nature to a lot of Emacs users, Ido offers in
;; addition to the default substring-matching-method (look above) also the
;; prefix-matching-method. The kind of matching is the only difference to
;; the description of the substring-matching above.
@@ -206,7 +206,7 @@
;; Customization
;; -------------
;;
-;; Customize the `ido' group to change the `ido' functionality.
+;; Customize the Ido group to change the Ido functionality.
;;
;; To modify the keybindings, use the ido-setup-hook. For example:
;;(add-hook 'ido-setup-hook 'ido-my-keys)
@@ -277,7 +277,7 @@
;; If you don't want to rely on the `ido-everywhere' functionality,
;; ido-read-buffer, ido-read-file-name, and ido-read-directory-name
;; can be used by other packages to read a buffer name, a file name,
-;; or a directory name in the `ido' way.
+;; or a directory name in the Ido way.
;;; Acknowledgments
@@ -345,11 +345,11 @@
(defcustom ido-mode nil
"Determines for which buffer/file Ido should be enabled.
The following values are possible:
-- `buffer': Turn only on ido buffer behavior (switching, killing,
+- `buffer': Turn only on Ido buffer behavior (switching, killing,
displaying...)
-- `file': Turn only on ido file behavior (finding, writing, inserting...)
-- `both': Turn on ido buffer and file behavior.
-- nil: Turn off any ido switching.
+- `file': Turn only on Ido file behavior (finding, writing, inserting...)
+- `both': Turn on Ido buffer and file behavior.
+- nil: Turn off any Ido switching.
Setting this variable directly does not take effect;
use either \\[customize] or the function `ido-mode'."
@@ -467,7 +467,7 @@
:group 'ido)
(defcustom ido-enable-flex-matching nil
- "Non-nil means that `ido' will do flexible string matching.
+ "Non-nil means that Ido will do flexible string matching.
Flexible matching means that if the entered string does not
match any item, any item containing the entered characters
in the given sequence will match."
@@ -476,8 +476,8 @@
(defcustom ido-enable-regexp nil
- "Non-nil means that `ido' will do regexp matching.
-Value can be toggled within `ido' using `ido-toggle-regexp'."
+ "Non-nil means that Ido will do regexp matching.
+Value can be toggled within Ido using `ido-toggle-regexp'."
:type 'boolean
:group 'ido)
@@ -485,7 +485,7 @@
"Non-nil means only match if the entered text is a prefix of file name.
This behavior is like the standard Emacs completion.
If nil, match if the entered text is an arbitrary substring.
-Value can be toggled within `ido' using `ido-toggle-prefix'."
+Value can be toggled within Ido using `ido-toggle-prefix'."
:type 'boolean
:group 'ido)
@@ -499,7 +499,7 @@
;; See http://debbugs.gnu.org/2042 for more info.
(defcustom ido-buffer-disable-smart-matches t
"Non-nil means not to re-order matches for buffer switching.
-By default, ido arranges matches in the following order:
+By default, Ido arranges matches in the following order:
full-matches > suffix matches > prefix matches > remaining matches
@@ -564,7 +564,7 @@
:group 'ido)
(defcustom ido-enable-last-directory-history t
- "Non-nil means that `ido' will remember latest selected directory names.
+ "Non-nil means that Ido will remember latest selected directory names.
See `ido-last-directory-list' and `ido-save-directory-list-file'."
:type 'boolean
:group 'ido)
@@ -585,7 +585,7 @@
(defcustom ido-use-filename-at-point nil
- "Non-nil means that ido shall look for a filename at point.
+ "Non-nil means that Ido shall look for a filename at point.
May use `ffap-guesser' to guess whether text at point is a filename.
If found, use that as the starting point for filename selection."
:type '(choice
@@ -603,38 +603,38 @@
(defcustom ido-enable-tramp-completion t
- "Non-nil means that ido shall perform tramp method and server name
completion.
+ "Non-nil means that Ido shall perform tramp method and server name
completion.
A tramp file name uses the following syntax: /method:address@hidden:filename."
:type 'boolean
:group 'ido)
(defcustom ido-record-ftp-work-directories t
- "Non-nil means record ftp file names in the work directory list."
+ "Non-nil means record FTP file names in the work directory list."
:type 'boolean
:group 'ido)
(defcustom ido-merge-ftp-work-directories nil
- "If nil, merging ignores ftp file names in the work directory list."
+ "If nil, merging ignores FTP file names in the work directory list."
:type 'boolean
:group 'ido)
(defcustom ido-cache-ftp-work-directory-time 1.0
- "Maximum time to cache contents of an ftp directory (in hours).
+ "Maximum time to cache contents of an FTP directory (in hours).
\\<ido-file-completion-map>
Use \\[ido-reread-directory] in prompt to refresh list.
-If zero, ftp directories are not cached."
+If zero, FTP directories are not cached."
:type 'number
:group 'ido)
(defcustom ido-slow-ftp-hosts nil
- "List of slow ftp hosts where ido prompting should not be used.
-If an ftp host is on this list, ido automatically switches to the non-ido
+ "List of slow FTP hosts where Ido prompting should not be used.
+If an FTP host is on this list, Ido automatically switches to the non-Ido
equivalent function, e.g. `find-file' rather than `ido-find-file'."
:type '(repeat string)
:group 'ido)
(defcustom ido-slow-ftp-host-regexps nil
- "List of regexps matching slow ftp hosts (see `ido-slow-ftp-hosts')."
+ "List of regexps matching slow FTP hosts (see `ido-slow-ftp-hosts')."
:type '(repeat regexp)
:group 'ido)
@@ -726,16 +726,16 @@
:group 'ido)
(defcustom ido-max-directory-size nil
- "Maximum size (in bytes) for directories to use ido completion.
+ "Maximum size (in bytes) for directories to use Ido completion.
\\<ido-completion-map>
-If you enter a directory with a size larger than this size, ido will
+If you enter a directory with a size larger than this size, Ido will
not provide the normal completion. To show the completions, use
\\[ido-toggle-ignore]."
:type '(choice (const :tag "No limit" nil)
(integer :tag "Size in bytes" 30000))
:group 'ido)
(defcustom ido-rotate-file-list-default nil
- "Non-nil means that `ido' will always rotate file list to get default in
front."
+ "Non-nil means that Ido will always rotate file list to get default in
front."
:type 'boolean
:group 'ido)
@@ -762,21 +762,23 @@
:group 'ido)
(defcustom ido-setup-hook nil
- "Hook run after the ido variables and keymap have been setup.
+ "Hook run after the Ido variables and keymap have been setup.
The dynamic variable `ido-cur-item' contains the current type of item that
-is read by ido; possible values are file, dir, buffer, and list.
+is read by Ido; possible values are file, dir, buffer, and list.
Additional keys can be defined in `ido-completion-map'."
:type 'hook
:group 'ido)
(defcustom ido-separator nil
- "String used by ido to separate the alternatives in the minibuffer.
-Obsolete. Set 3rd element of `ido-decorations' instead."
+ "String used by Ido to separate the alternatives in the minibuffer."
:type '(choice string (const nil))
:group 'ido)
+(make-obsolete-variable 'ido-separator
+ "set 3rd element of `ido-decorations' instead." nil)
-(defcustom ido-decorations '( "{" "}" " | " " | ..." "[" "]" " [No match]" "
[Matched]" " [Not readable]" " [Too big]" " [Confirm]")
- "List of strings used by ido to display the alternatives in the minibuffer.
+(defcustom ido-decorations '("{" "}" " | " " | ..." "[" "]" " [No match]"
+ " [Matched]" " [Not readable]" " [Too big]" "
[Confirm]")
+ "List of strings used by Ido to display the alternatives in the minibuffer.
There are between 11 and 13 elements in this list:
1st and 2nd elements are used as brackets around the prospect list,
3rd element is the separator between prospects (ignored if
@@ -820,19 +822,19 @@
:group 'ido)
(defcustom ido-use-faces t
- "Non-nil means use ido faces to highlighting first match, only match and
+ "Non-nil means use Ido faces to highlighting first match, only match and
subdirs in the alternatives."
:type 'boolean
:group 'ido)
(defface ido-first-match '((t :weight bold))
- "Face used by ido for highlighting first match."
+ "Face used by Ido for highlighting first match."
:group 'ido)
(defface ido-only-match '((((class color))
:foreground "ForestGreen")
(t :slant italic))
- "Face used by ido for highlighting only match."
+ "Face used by Ido for highlighting only match."
:group 'ido)
(defface ido-subdir '((((min-colors 88) (class color))
@@ -840,11 +842,11 @@
(((class color))
:foreground "red")
(t :underline t))
- "Face used by ido for highlighting subdirs in the alternatives."
+ "Face used by Ido for highlighting subdirs in the alternatives."
:group 'ido)
(defface ido-virtual '((t :inherit font-lock-builtin-face))
- "Face used by ido for matching virtual buffer names."
+ "Face used by Ido for matching virtual buffer names."
:version "24.1"
:group 'ido)
@@ -853,7 +855,7 @@
(((class color))
:foreground "yellow" :background "red" :width
condensed)
(t :inverse-video t))
- "Face used by ido for highlighting its indicators."
+ "Face used by Ido for highlighting its indicators."
:group 'ido)
(defface ido-incomplete-regexp
@@ -901,7 +903,7 @@
:group 'ido)
(defvar ido-rewrite-file-prompt-rules nil
- "Alist of rewriting rules for directory names in ido prompts.
+ "Alist of rewriting rules for directory names in Ido prompts.
A list of elements of the form (FROM . TO) or (FROM . FUNC), each
meaning to rewrite the directory name if matched by FROM by either
substituting the matched string by TO or calling the function FUNC
@@ -911,7 +913,7 @@
`ido-rewrite-file-prompt-functions'.")
(defcustom ido-completion-buffer "*Ido Completions*"
- "Name of completion buffer used by ido.
+ "Name of completion buffer used by Ido.
Set to nil to disable completion buffers popping up."
:type 'string
:group 'ido)
@@ -934,40 +936,37 @@
(defcustom ido-minibuffer-setup-hook nil
"Ido-specific customization of minibuffer setup.
-This hook is run during minibuffer setup if `ido' is active.
-It is intended for use in customizing ido for interoperation
+This hook is run during minibuffer setup if Ido is active.
+It is intended for use in customizing Ido for interoperation
with other packages. For instance:
- \(add-hook 'ido-minibuffer-setup-hook
- \(function
- \(lambda ()
- \(make-local-variable 'max-mini-window-height)
- \(setq max-mini-window-height 3))))
+ (add-hook 'ido-minibuffer-setup-hook
+ (lambda () (setq-local max-mini-window-height 3)))
will constrain Emacs to a maximum minibuffer height of 3 lines when
-ido is running. Copied from `icomplete-minibuffer-setup-hook'."
+Ido is running. Copied from `icomplete-minibuffer-setup-hook'."
:type 'hook
:group 'ido)
(defcustom ido-save-directory-list-file
(locate-user-emacs-file "ido.last" ".ido.last")
- "File in which the ido state is saved between invocations.
+ "File in which the Ido state is saved between invocations.
Variables stored are: `ido-last-directory-list', `ido-work-directory-list',
`ido-work-file-list', and `ido-dir-file-cache'.
-Must be set before enabling ido mode."
+Must be set before enabling Ido mode."
:version "24.4" ; added locate-user-emacs-file
:type 'string
:group 'ido)
(defcustom ido-read-file-name-as-directory-commands '()
- "List of commands which uses `read-file-name' to read a directory name.
+ "List of commands which use `read-file-name' to read a directory name.
When `ido-everywhere' is non-nil, the commands in this list will read
the directory using `ido-read-directory-name'."
:type '(repeat symbol)
:group 'ido)
(defcustom ido-read-file-name-non-ido '()
- "List of commands which shall not read file names the ido way.
+ "List of commands which shall not read file names the Ido way.
When `ido-everywhere' is non-nil, the commands in this list will read
the file name using normal `read-file-name' style."
:type '(repeat symbol)
@@ -984,19 +983,19 @@
;; Persistent variables
(defvar ido-completion-map nil
- "Currently active keymap for ido commands.")
+ "Currently active keymap for Ido commands.")
(defvar ido-common-completion-map nil
- "Keymap for all ido commands.")
+ "Keymap for all Ido commands.")
(defvar ido-file-completion-map nil
- "Keymap for ido file commands.")
+ "Keymap for Ido file commands.")
(defvar ido-file-dir-completion-map nil
- "Keymap for ido file and directory commands.")
+ "Keymap for Ido file and directory commands.")
(defvar ido-buffer-completion-map nil
- "Keymap for ido buffer commands.")
+ "Keymap for Ido buffer commands.")
(defvar ido-file-history nil
"History of files selected using `ido-find-file'.")
@@ -1024,8 +1023,8 @@
Each element in the list is of the form (DIR (MTIME) FILE...).")
(defvar ido-ignore-item-temp-list nil
- "List of items to ignore in current ido invocation.
-Intended to be let-bound by functions which call ido repeatedly.
+ "List of items to ignore in current Ido invocation.
+Intended to be let-bound by functions which call Ido repeatedly.
Should never be set permanently.")
;; Temporary storage
@@ -1045,19 +1044,19 @@
"Non-nil means we are rotating list of matches.")
(defvar ido-text nil
- "Stores the users string as it is typed in.")
+ "Stores the user's string as it is typed in.")
(defvar ido-text-init nil
- "The initial string for the users string it is typed in.")
+ "The initial string for the user's string it is typed in.")
(defvar ido-input-stack nil
- "Stores the users strings when user hits M-b/M-f.")
+ "Stores the user's strings when user hits M-b/M-f.")
(defvar ido-matches nil
"List of files currently matching `ido-text'.")
(defvar ido-report-no-match t
- "Report [No Match] when no completions matches `ido-text'.")
+ "Report \"[No Match]\" when no completions matches `ido-text'.")
(defvar ido-exit nil
"Flag to monitor how `ido-find-file' exits.
@@ -1071,8 +1070,8 @@
"Delay timer for auto merge.")
(defvar ido-use-mycompletion-depth 0
- "Non-nil means use `ido' completion feedback.
-Is set by ido functions to the current `minibuffer-depth',
+ "Non-nil means use Ido completion feedback.
+Is set by Ido functions to the current `minibuffer-depth',
so that it doesn't interfere with other minibuffer usage.")
(defvar ido-incomplete-regexp nil
@@ -1283,7 +1282,8 @@
(defun ido-is-ftp-directory (&optional dir)
(string-match
(if ido-enable-tramp-completion
- "\\`/[^/:][^/:]+:" ;; like tramp-file-name-regexp-unified, but doesn't
match single drive letters
+ ;; like tramp-file-name-regexp-unified, but doesn't match single drive
letters
+ "\\`/[^/:][^/:]+:"
"\\`/[^/:][^/:]+:/")
(or dir ido-current-directory)))
@@ -1353,7 +1353,7 @@
(insert "\n)\n")))
(defun ido-save-history ()
- "Save ido history and cache information between sessions."
+ "Save Ido history and cache information between sessions."
(interactive)
(when (and ido-last-directory-list ido-save-directory-list-file)
(let ((buf (get-buffer-create " *ido session*"))
@@ -1374,7 +1374,7 @@
(kill-buffer buf)))))
(defun ido-load-history (&optional arg)
- "Load ido history and cache information from previous session.
+ "Load Ido history and cache information from previous session.
With prefix argument, reload history unconditionally."
(interactive "P")
(if (or arg (and ido-save-directory-list-file (not ido-last-directory-list)))
@@ -1397,7 +1397,7 @@
(ido-wash-history))
(defun ido-wash-history ()
- "Clean-up ido history and cache information.
+ "Clean-up Ido history and cache information.
Removes badly formatted data and ignored directories."
(interactive)
;; Check format of each of our lists, discard bogus elements
@@ -1510,8 +1510,8 @@
(define-minor-mode ido-everywhere
"Toggle use of Ido for all buffer/file reading.
With a prefix argument ARG, enable this feature if ARG is
-positive, and disable it otherwise. If called from Lisp, enable
-the mode if ARG is omitted or nil."
+positive, and disable it otherwise. If called from Lisp,
+enable the mode if ARG is omitted or nil."
:global t
:group 'ido
(when (get 'ido-everywhere 'file)
@@ -1532,11 +1532,11 @@
;;;###autoload
(defun ido-mode (&optional arg)
- "Toggle ido mode on or off.
-With ARG, turn ido-mode on if arg is positive, off otherwise.
-Turning on ido-mode will remap (via a minor-mode keymap) the default
+ "Toggle Ido mode on or off.
+With ARG, turn Ido mode on if arg is positive, off otherwise.
+Turning on Ido mode will remap (via a minor-mode keymap) the default
keybindings for the `find-file' and `switch-to-buffer' families of
-commands to the ido versions of these functions.
+commands to the Ido versions of these functions.
However, if ARG arg equals 'files, remap only commands for files, or
if it equals 'buffers, remap only commands for buffer switching.
This function also adds a hook to the minibuffer."
@@ -1598,7 +1598,7 @@
;;; IDO KEYMAP
(defun ido-init-completion-maps ()
- "Set up the completion keymaps used by `ido'."
+ "Set up the completion keymaps used by Ido."
;; Common map
(let ((map (make-sparse-keymap)))
@@ -1679,7 +1679,7 @@
(defun ido-setup-completion-map ()
- "Set up the keymap for `ido'."
+ "Set up the keymap for Ido."
;; generated every time so that it can inherit new functions.
(let ((map (make-sparse-keymap))
@@ -2205,7 +2205,7 @@
ido-selected))
(defun ido-edit-input ()
- "Edit absolute file name entered so far with ido; terminate by RET.
+ "Edit absolute file name entered so far with Ido; terminate by RET.
If cursor is not at the end of the user input, move to end of input."
(interactive)
(if (not (eobp))
@@ -2616,7 +2616,7 @@
(ido-complete)))
(defun ido-undo-merge-work-directory (&optional text try refresh)
- "Undo or redo last ido directory merge operation.
+ "Undo or redo last Ido directory merge operation.
If no merge has yet taken place, toggle automatic merging option."
(interactive)
(cond
@@ -2648,9 +2648,9 @@
"Move forward in user input or perform magic action.
If no user input is present, or at end of input, perform magic actions:
C-x C-b ... C-f switch to `ido-find-file'.
-C-x C-f ... C-f fallback to non-ido `find-file'.
-C-x C-d ... C-f fallback to non-ido brief `dired'.
-C-x d ... C-f fallback to non-ido `dired'."
+C-x C-f ... C-f fallback to non-Ido `find-file'.
+C-x C-d ... C-f fallback to non-Ido brief `dired'.
+C-x d ... C-f fallback to non-Ido `dired'."
(interactive "P")
(cond
((or arg (not (eobp)))
@@ -2671,7 +2671,7 @@
C-x C-f C-b switch to `ido-switch-buffer'.
C-x C-d C-b switch to `ido-switch-buffer'.
C-x d C-b switch to `ido-switch-buffer'.
-C-x C-b C-b fallback to non-ido `switch-to-buffer'."
+C-x C-b C-b fallback to non-Ido `switch-to-buffer'."
(interactive "P")
(cond
((or arg (> (point) (minibuffer-prompt-end)))
@@ -2744,7 +2744,7 @@
(exit-minibuffer)))
(defun ido-toggle-vc ()
- "Disable version control for this file."
+ "Toggle version control for this file."
(interactive)
(if (and ido-mode (eq ido-cur-item 'file))
(progn
@@ -2781,7 +2781,7 @@
(defun ido-reread-directory ()
"Read current directory again.
May be useful if cached version is no longer valid, but directory
-timestamp has not changed (e.g. with ftp or on Windows)."
+timestamp has not changed (e.g. with FTP or on Windows)."
(interactive)
(if (and ido-mode (memq ido-cur-item '(file dir)))
(progn
@@ -2815,7 +2815,7 @@
(exit-minibuffer))
(defun ido-fallback-command ()
- "Fallback to non-ido version of current command."
+ "Fallback to non-Ido version of current command."
(interactive)
(let ((i (length ido-text)))
(while (> i 0)
@@ -2949,7 +2949,7 @@
(exit-minibuffer))
(defun ido-wide-find-file (&optional file)
- "Prompt for FILE to search for using find, starting from current directory."
+ "Prompt for FILE to search for using `find', starting from current
directory."
(interactive)
(unless file
(let ((enable-recursive-minibuffers t))
@@ -2965,7 +2965,7 @@
(exit-minibuffer)))
(defun ido-wide-find-dir (&optional dir)
- "Prompt for DIR to search for using find, starting from current directory."
+ "Prompt for DIR to search for using `find', starting from current directory."
(interactive)
(unless dir
(let ((enable-recursive-minibuffers t))
@@ -2981,7 +2981,7 @@
(exit-minibuffer)))
(defun ido-wide-find-dir-or-delete-dir (&optional _dir)
- "Prompt for DIR to search for using find, starting from current directory.
+ "Prompt for DIR to search for using `find', starting from current directory.
If input stack is non-empty, delete current directory component."
(interactive)
(if ido-input-stack
@@ -3938,7 +3938,7 @@
t))
(defun ido-completion-help ()
- "Show possible completions in a *File Completions* buffer."
+ "Show possible completions in a \"*File Completions*\" buffer."
(interactive)
(setq ido-rescan nil)
(let ((temp-buf (and ido-completion-buffer
@@ -4119,31 +4119,31 @@
in another frame.
As you type in a string, all of the buffers matching the string are
-displayed if substring-matching is used \(default). Look at
+displayed if substring-matching is used (default). Look at
`ido-enable-prefix' and `ido-toggle-prefix'. When you have found the
buffer you want, it can then be selected. As you type, most keys have
their normal keybindings, except for the following:
\\<ido-buffer-completion-map>
-RET Select the buffer at the front of the list of matches. If the
-list is empty, possibly prompt to create new buffer.
-
-\\[ido-select-text] Use the current input string verbatim.
-
-\\[ido-next-match] Put the first element at the end of the list.
-\\[ido-prev-match] Put the last element at the start of the list.
-\\[ido-complete] Complete a common suffix to the current string that
-matches all buffers. If there is only one match, select that buffer.
-If there is no common suffix, show a list of all matching buffers
-in a separate window.
-\\[ido-edit-input] Edit input string.
-\\[ido-fallback-command] Fallback to non-ido version of current command.
-\\[ido-toggle-regexp] Toggle regexp searching.
-\\[ido-toggle-prefix] Toggle between substring and prefix matching.
-\\[ido-toggle-case] Toggle case-sensitive searching of buffer names.
-\\[ido-completion-help] Show list of matching buffers in separate window.
-\\[ido-enter-find-file] Drop into `ido-find-file'.
-\\[ido-kill-buffer-at-head] Kill buffer at head of buffer list.
-\\[ido-toggle-ignore] Toggle ignoring buffers listed in `ido-ignore-buffers'."
+RET\tSelect the buffer at the front of the list of matches.
+\tIf the list is empty, possibly prompt to create new buffer.
+
+\\[ido-select-text]\tUse the current input string verbatim.
+
+\\[ido-next-match]\tPut the first element at the end of the list.
+\\[ido-prev-match]\tPut the last element at the start of the list.
+\\[ido-complete]\tComplete a common suffix to the current string that matches
+\tall buffers. If there is only one match, select that buffer.
+\tIf there is no common suffix, show a list of all matching buffers
+\tin a separate window.
+\\[ido-edit-input]\tEdit input string.
+\\[ido-fallback-command]\tFallback to non-ido version of current command.
+\\[ido-toggle-regexp]\tToggle regexp searching.
+\\[ido-toggle-prefix]\tToggle between substring and prefix matching.
+\\[ido-toggle-case]\tToggle case-sensitive searching of buffer names.
+\\[ido-completion-help]\tShow list of matching buffers in separate window.
+\\[ido-enter-find-file]\tDrop into `ido-find-file'.
+\\[ido-kill-buffer-at-head]\tKill buffer at head of buffer list.
+\\[ido-toggle-ignore]\tToggle ignoring buffers listed in `ido-ignore-buffers'."
(interactive)
(ido-buffer-internal ido-default-buffer-method))
@@ -4169,7 +4169,8 @@
The buffer name is selected interactively by typing a substring.
For details of keybindings, see `ido-switch-buffer'."
(interactive)
- (ido-buffer-internal 'kill 'kill-buffer "Kill buffer: " (buffer-name
(current-buffer)) nil 'ignore))
+ (ido-buffer-internal 'kill 'kill-buffer "Kill buffer: "
+ (buffer-name (current-buffer)) nil 'ignore))
;;;###autoload
(defun ido-insert-buffer ()
@@ -4177,7 +4178,8 @@
The buffer name is selected interactively by typing a substring.
For details of keybindings, see `ido-switch-buffer'."
(interactive)
- (ido-buffer-internal 'insert 'insert-buffer "Insert buffer: " nil nil
'ido-enter-insert-file))
+ (ido-buffer-internal 'insert 'insert-buffer "Insert buffer: "
+ nil nil 'ido-enter-insert-file))
;;;###autoload
(defun ido-switch-buffer-other-frame ()
@@ -4200,42 +4202,45 @@
(defun ido-find-file ()
"Edit file with name obtained via minibuffer.
The file is displayed according to `ido-default-file-method' -- the
-default is to show it in the same window, unless it is already
-visible in another frame.
+default is to show it in the same window, unless it is already visible
+in another frame.
The file name is selected interactively by typing a substring. As you
type in a string, all of the filenames matching the string are displayed
-if substring-matching is used \(default). Look at `ido-enable-prefix' and
+if substring-matching is used (default). Look at `ido-enable-prefix' and
`ido-toggle-prefix'. When you have found the filename you want, it can
then be selected. As you type, most keys have their normal keybindings,
except for the following: \\<ido-file-completion-map>
-RET Select the file at the front of the list of matches. If the
-list is empty, possibly prompt to create new file.
-
-\\[ido-select-text] Use the current input string verbatim.
-
-\\[ido-next-match] Put the first element at the end of the list.
-\\[ido-prev-match] Put the last element at the start of the list.
-\\[ido-complete] Complete a common suffix to the current string that
-matches all files. If there is only one match, select that file.
-If there is no common suffix, show a list of all matching files
-in a separate window.
-\\[ido-magic-delete-char] Open the specified directory in Dired mode.
-\\[ido-edit-input] Edit input string (including directory).
-\\[ido-prev-work-directory] or \\[ido-next-work-directory] go to previous/next
directory in work directory history.
-\\[ido-merge-work-directories] search for file in the work directory history.
-\\[ido-forget-work-directory] removes current directory from the work
directory history.
-\\[ido-prev-work-file] or \\[ido-next-work-file] cycle through the work file
history.
-\\[ido-wide-find-file-or-pop-dir] and \\[ido-wide-find-dir-or-delete-dir]
prompts and uses find to locate files or directories.
-\\[ido-make-directory] prompts for a directory to create in current directory.
-\\[ido-fallback-command] Fallback to non-ido version of current command.
-\\[ido-toggle-regexp] Toggle regexp searching.
-\\[ido-toggle-prefix] Toggle between substring and prefix matching.
-\\[ido-toggle-case] Toggle case-sensitive searching of file names.
-\\[ido-toggle-literal] Toggle literal reading of this file.
-\\[ido-completion-help] Show list of matching files in separate window.
-\\[ido-toggle-ignore] Toggle ignoring files listed in `ido-ignore-files'."
+RET\tSelect the file at the front of the list of matches.
+\tIf the list is empty, possibly prompt to create new file.
+
+\\[ido-select-text]\tUse the current input string verbatim.
+
+\\[ido-next-match]\tPut the first element at the end of the list.
+\\[ido-prev-match]\tPut the last element at the start of the list.
+\\[ido-complete]\tComplete a common suffix to the current string that matches
+\tall files. If there is only one match, select that file.
+\tIf there is no common suffix, show a list of all matching files
+\tin a separate window.
+\\[ido-magic-delete-char]\tOpen the specified directory in Dired mode.
+\\[ido-edit-input]\tEdit input string (including directory).
+\\[ido-prev-work-directory]\tGo to previous directory in work directory
history.
+\\[ido-next-work-directory]\tGo to next directory in work directory history.
+\\[ido-merge-work-directories]\tSearch for file in the work directory history.
+\\[ido-forget-work-directory]\tRemove current directory from the work
directory history.
+\\[ido-prev-work-file]\tCycle to previous file in work file history.
+\\[ido-next-work-file]\tCycle to next file in work file history.
+\\[ido-wide-find-file-or-pop-dir]\tPrompt for a file and use find to locate it.
+\\[ido-wide-find-dir-or-delete-dir]\tPrompt for a directory and use find to
locate it.
+\\[ido-make-directory]\tPrompt for a directory to create in current directory.
+\\[ido-fallback-command]\tFallback to non-Ido version of current command.
+\\[ido-toggle-regexp]\tToggle regexp searching.
+\\[ido-toggle-prefix]\tToggle between substring and prefix matching.
+\\[ido-toggle-case]\tToggle case-sensitive searching of file names.
+\\[ido-toggle-literal]\tToggle literal reading of this file.
+\\[ido-completion-help]\tShow list of matching files in separate window.
+\\[ido-toggle-ignore]\tToggle ignoring files listed in `ido-ignore-files'."
(interactive)
(ido-file-internal ido-default-file-method))
@@ -4270,7 +4275,8 @@
The file name is selected interactively by typing a substring.
For details of keybindings, see `ido-find-file'."
(interactive)
- (ido-file-internal 'read-only 'find-file-read-only-other-window nil "Find
file read-only other window: "))
+ (ido-file-internal 'read-only 'find-file-read-only-other-window nil
+ "Find file read-only other window: "))
;;;###autoload
(defun ido-find-file-read-only-other-frame ()
@@ -4278,7 +4284,8 @@
The file name is selected interactively by typing a substring.
For details of keybindings, see `ido-find-file'."
(interactive)
- (ido-file-internal 'read-only 'find-file-read-only-other-frame nil "Find
file read-only other frame: "))
+ (ido-file-internal 'read-only 'find-file-read-only-other-frame nil
+ "Find file read-only other frame: "))
;;;###autoload
(defun ido-display-file ()
@@ -4320,7 +4327,7 @@
;;;###autoload
(defun ido-dired ()
- "Call `dired' the ido way.
+ "Call `dired' the Ido way.
The directory is selected interactively by typing a substring.
For details of keybindings, see `ido-find-file'."
(interactive)
@@ -4329,7 +4336,7 @@
(ido-file-internal 'dired 'dired nil "Dired: " 'dir)))
(defun ido-list-directory ()
- "Call `list-directory' the ido way.
+ "Call `list-directory' the Ido way.
The directory is selected interactively by typing a substring.
For details of keybindings, see `ido-find-file'."
(interactive)
@@ -4367,7 +4374,7 @@
(throw 'ido contents))))
(defun ido-exhibit ()
- "Post command hook for `ido'."
+ "Post command hook for Ido."
;; Find matching files and display a list in the minibuffer.
;; Copied from `icomplete-exhibit' with two changes:
;; 1. It prints a default file name when there is no text yet entered.
@@ -4695,7 +4702,7 @@
(nth 1 ido-decorations)))))))
(defun ido-minibuffer-setup ()
- "Minibuffer setup hook for `ido'."
+ "Minibuffer setup hook for Ido."
;; Copied from `icomplete-minibuffer-setup-hook'.
(when (ido-active)
(add-hook 'pre-command-hook 'ido-tidy nil t)
@@ -4709,7 +4716,7 @@
(setq ido-initial-position nil))))
(defun ido-tidy ()
- "Pre command hook for `ido'."
+ "Pre command hook for Ido."
;; Remove completions display, if any, prior to new user input.
;; Copied from `icomplete-tidy'."
@@ -4868,10 +4875,10 @@
(defun ido-completing-read (prompt choices &optional _predicate require-match
initial-input hist def _inherit-input-method)
"Ido replacement for the built-in `completing-read'.
-Read a string in the minibuffer with ido-style completion.
+Read a string in the minibuffer with Ido-style completion.
PROMPT is a string to prompt with; normally it ends in a colon and a space.
CHOICES is a list of strings which are the possible completions.
-PREDICATE and INHERIT-INPUT-METHOD is currently ignored; it is included
+PREDICATE and INHERIT-INPUT-METHOD are currently ignored; they are included
to be compatible with `completing-read'.
If REQUIRE-MATCH is non-nil, the user is not allowed to exit unless
the input is (or completes to) an element of CHOICES or is null.
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Emacs-diffs] trunk r116637: lisp/icomplete.el, lisp/ido.el: Doc fixes.,
Juanma Barranquero <=