[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Emacs-diffs] /srv/bzr/emacs/trunk r101621: Cosmetic doc fixes for eshel
|
From: |
Glenn Morris |
|
Subject: |
[Emacs-diffs] /srv/bzr/emacs/trunk r101621: Cosmetic doc fixes for eshell. |
|
Date: |
Sat, 25 Sep 2010 14:51:55 -0700 |
|
User-agent: |
Bazaar (2.0.3) |
------------------------------------------------------------
revno: 101621
committer: Glenn Morris <address@hidden>
branch nick: trunk
timestamp: Sat 2010-09-25 14:51:55 -0700
message:
Cosmetic doc fixes for eshell.
* eshell/em-alias.el, eshell/em-banner.el, eshell/em-basic.el:
* eshell/em-cmpl.el, eshell/em-dirs.el, eshell/em-glob.el:
* eshell/em-hist.el, eshell/em-ls.el, eshell/em-pred.el:
* eshell/em-prompt.el, eshell/em-rebind.el, eshell/em-script.el:
* eshell/em-smart.el, eshell/em-term.el, eshell/em-unix.el:
* eshell/esh-cmd.el, eshell/esh-ext.el, eshell/esh-io.el:
* eshell/esh-mode.el, eshell/esh-proc.el, eshell/esh-test.el:
* eshell/esh-util.el, eshell/esh-var.el:
Remove leading `*' from docs of faces and defcustoms.
modified:
lisp/ChangeLog
lisp/eshell/em-alias.el
lisp/eshell/em-banner.el
lisp/eshell/em-basic.el
lisp/eshell/em-cmpl.el
lisp/eshell/em-dirs.el
lisp/eshell/em-glob.el
lisp/eshell/em-hist.el
lisp/eshell/em-ls.el
lisp/eshell/em-pred.el
lisp/eshell/em-prompt.el
lisp/eshell/em-rebind.el
lisp/eshell/em-script.el
lisp/eshell/em-smart.el
lisp/eshell/em-term.el
lisp/eshell/em-unix.el
lisp/eshell/esh-cmd.el
lisp/eshell/esh-ext.el
lisp/eshell/esh-io.el
lisp/eshell/esh-mode.el
lisp/eshell/esh-proc.el
lisp/eshell/esh-test.el
lisp/eshell/esh-util.el
lisp/eshell/esh-var.el
=== modified file 'lisp/ChangeLog'
--- a/lisp/ChangeLog 2010-09-25 21:42:48 +0000
+++ b/lisp/ChangeLog 2010-09-25 21:51:55 +0000
@@ -1,3 +1,15 @@
+2010-09-25 Glenn Morris <address@hidden>
+
+ * eshell/em-alias.el, eshell/em-banner.el, eshell/em-basic.el:
+ * eshell/em-cmpl.el, eshell/em-dirs.el, eshell/em-glob.el:
+ * eshell/em-hist.el, eshell/em-ls.el, eshell/em-pred.el:
+ * eshell/em-prompt.el, eshell/em-rebind.el, eshell/em-script.el:
+ * eshell/em-smart.el, eshell/em-term.el, eshell/em-unix.el:
+ * eshell/esh-cmd.el, eshell/esh-ext.el, eshell/esh-io.el:
+ * eshell/esh-mode.el, eshell/esh-proc.el, eshell/esh-test.el:
+ * eshell/esh-util.el, eshell/esh-var.el:
+ Remove leading `*' from docs of faces and defcustoms.
+
2010-09-25 Ulrich Mueller <address@hidden>
* eshell/em-ls.el (eshell-ls-archive-regexp):
=== modified file 'lisp/eshell/em-alias.el'
--- a/lisp/eshell/em-alias.el 2010-01-13 08:35:10 +0000
+++ b/lisp/eshell/em-alias.el 2010-09-25 21:51:55 +0000
@@ -103,7 +103,7 @@
:group 'eshell-module)
(defcustom eshell-aliases-file (expand-file-name "alias" eshell-directory-name)
- "*The file in which aliases are kept.
+ "The file in which aliases are kept.
Whenever an alias is defined by the user, using the `alias' command,
it will be written to this file. Thus, alias definitions (and
deletions) are always permanent. This approach was chosen for the
@@ -113,13 +113,13 @@
:group 'eshell-alias)
(defcustom eshell-bad-command-tolerance 3
- "*The number of failed commands to ignore before creating an alias."
+ "The number of failed commands to ignore before creating an alias."
:type 'integer
;; :link '(custom-manual "(eshell)Auto-correction of bad commands")
:group 'eshell-alias)
(defcustom eshell-alias-load-hook '(eshell-alias-initialize)
- "*A hook that gets run when `eshell-alias' is loaded."
+ "A hook that gets run when `eshell-alias' is loaded."
:type 'hook
:group 'eshell-alias)
=== modified file 'lisp/eshell/em-banner.el'
--- a/lisp/eshell/em-banner.el 2010-01-13 08:35:10 +0000
+++ b/lisp/eshell/em-banner.el 2010-09-25 21:51:55 +0000
@@ -58,7 +58,7 @@
;;; User Variables:
(defcustom eshell-banner-message "Welcome to the Emacs shell\n\n"
- "*The banner message to be displayed when Eshell is loaded.
+ "The banner message to be displayed when Eshell is loaded.
This can be any sexp, and should end with at least two newlines."
:type 'sexp
:group 'eshell-banner)
@@ -66,7 +66,7 @@
(put 'eshell-banner-message 'risky-local-variable t)
(defcustom eshell-banner-load-hook '(eshell-banner-initialize)
- "*A list of functions to run when `eshell-banner' is loaded."
+ "A list of functions to run when `eshell-banner' is loaded."
:type 'hook
:group 'eshell-banner)
=== modified file 'lisp/eshell/em-basic.el'
--- a/lisp/eshell/em-basic.el 2010-03-22 16:50:29 +0000
+++ b/lisp/eshell/em-basic.el 2010-09-25 21:51:55 +0000
@@ -77,7 +77,7 @@
:group 'eshell-module)
(defcustom eshell-plain-echo-behavior nil
- "*If non-nil, `echo' tries to behave like an ordinary shell echo.
+ "If non-nil, `echo' tries to behave like an ordinary shell echo.
This comes at some detriment to Lisp functionality. However, the Lisp
equivalent of `echo' can always be achieved by using `identity'."
:type 'boolean
=== modified file 'lisp/eshell/em-cmpl.el'
--- a/lisp/eshell/em-cmpl.el 2010-01-13 08:35:10 +0000
+++ b/lisp/eshell/em-cmpl.el 2010-09-25 21:51:55 +0000
@@ -86,26 +86,26 @@
;;; User Variables:
(defcustom eshell-cmpl-load-hook '(eshell-cmpl-initialize)
- "*A list of functions to run when `eshell-cmpl' is loaded."
+ "A list of functions to run when `eshell-cmpl' is loaded."
:type 'hook
:group 'eshell-cmpl)
(defcustom eshell-show-lisp-completions nil
- "*If non-nil, include Lisp functions in the command completion list.
+ "If non-nil, include Lisp functions in the command completion list.
If this variable is nil, Lisp completion can still be done in command
position by using M-TAB instead of TAB."
:type 'boolean
:group 'eshell-cmpl)
(defcustom eshell-show-lisp-alternatives t
- "*If non-nil, and no other completions found, show Lisp functions.
+ "If non-nil, and no other completions found, show Lisp functions.
Setting this variable means nothing if `eshell-show-lisp-completions'
is non-nil."
:type 'boolean
:group 'eshell-cmpl)
(defcustom eshell-no-completion-during-jobs t
- "*If non-nil, don't allow completion while a process is running."
+ "If non-nil, don't allow completion while a process is running."
:type 'boolean
:group 'eshell-cmpl)
@@ -126,7 +126,7 @@
("dbx" . "\\`\\([^.]*\\|a\\.out\\)\\'")
("sdb" . "\\`\\([^.]*\\|a\\.out\\)\\'")
("adb" . "\\`\\([^.]*\\|a\\.out\\)\\'"))
- "*An alist that defines simple argument type correlations.
+ "An alist that defines simple argument type correlations.
This is provided for common commands, as a simplistic alternative
to writing a completion function."
:type '(repeat (cons string regexp))
=== modified file 'lisp/eshell/em-dirs.el'
--- a/lisp/eshell/em-dirs.el 2010-03-22 16:50:29 +0000
+++ b/lisp/eshell/em-dirs.el 2010-09-25 21:51:55 +0000
@@ -60,14 +60,14 @@
;;; User Variables:
(defcustom eshell-dirs-load-hook '(eshell-dirs-initialize)
- "*A hook that gets run when `eshell-dirs' is loaded."
+ "A hook that gets run when `eshell-dirs' is loaded."
:type 'hook
:group 'eshell-dirs)
(defcustom eshell-pwd-convert-function (if (eshell-under-windows-p)
'expand-file-name
'identity)
- "*The function used to normalize the value of Eshell's `pwd'.
+ "The function used to normalize the value of Eshell's `pwd'.
The value returned by `pwd' is also used when recording the
last-visited directory in the last-dir-ring, so it will affect the
form of the list used by 'cd ='."
@@ -78,7 +78,7 @@
:group 'eshell-dirs)
(defcustom eshell-ask-to-save-last-dir 'always
- "*Determine if the last-dir-ring should be automatically saved.
+ "Determine if the last-dir-ring should be automatically saved.
The last-dir-ring is always preserved when exiting an Eshell buffer.
However, when Emacs is being shut down, this variable determines
whether to prompt the user, or just save the ring.
@@ -91,22 +91,22 @@
:group 'eshell-dirs)
(defcustom eshell-cd-shows-directory nil
- "*If non-nil, using `cd' will report the directory it changes to."
+ "If non-nil, using `cd' will report the directory it changes to."
:type 'boolean
:group 'eshell-dirs)
(defcustom eshell-cd-on-directory t
- "*If non-nil, do a cd if a directory is in command position."
+ "If non-nil, do a cd if a directory is in command position."
:type 'boolean
:group 'eshell-dirs)
(defcustom eshell-directory-change-hook nil
- "*A hook to run when the current directory changes."
+ "A hook to run when the current directory changes."
:type 'hook
:group 'eshell-dirs)
(defcustom eshell-list-files-after-cd nil
- "*If non-nil, call \"ls\" with any remaining args after doing a cd.
+ "If non-nil, call \"ls\" with any remaining args after doing a cd.
This is provided for convenience, since the same effect is easily
achieved by adding a function to `eshell-directory-change-hook' that
calls \"ls\" and references `eshell-last-arguments'."
@@ -114,39 +114,39 @@
:group 'eshell-dirs)
(defcustom eshell-pushd-tohome nil
- "*If non-nil, make pushd with no arg behave as 'pushd ~' (like `cd').
+ "If non-nil, make pushd with no arg behave as 'pushd ~' (like `cd').
This mirrors the optional behavior of tcsh."
:type 'boolean
:group 'eshell-dirs)
(defcustom eshell-pushd-dextract nil
- "*If non-nil, make \"pushd +n\" pop the nth dir to the stack top.
+ "If non-nil, make \"pushd +n\" pop the nth dir to the stack top.
This mirrors the optional behavior of tcsh."
:type 'boolean
:group 'eshell-dirs)
(defcustom eshell-pushd-dunique nil
- "*If non-nil, make pushd only add unique directories to the stack.
+ "If non-nil, make pushd only add unique directories to the stack.
This mirrors the optional behavior of tcsh."
:type 'boolean
:group 'eshell-dirs)
(defcustom eshell-dirtrack-verbose t
- "*If non-nil, show the directory stack following directory change.
+ "If non-nil, show the directory stack following directory change.
This is effective only if directory tracking is enabled."
:type 'boolean
:group 'eshell-dirs)
(defcustom eshell-last-dir-ring-file-name
(expand-file-name "lastdir" eshell-directory-name)
- "*If non-nil, name of the file to read/write the last-dir-ring.
+ "If non-nil, name of the file to read/write the last-dir-ring.
See also `eshell-read-last-dir-ring' and `eshell-write-last-dir-ring'.
If it is nil, the last-dir-ring will not be written to disk."
:type 'file
:group 'eshell-dirs)
(defcustom eshell-last-dir-ring-size 32
- "*If non-nil, the size of the directory history ring.
+ "If non-nil, the size of the directory history ring.
This ring is added to every time `cd' or `pushd' is used. It simply
stores the most recent directory locations Eshell has been in. To
return to the most recent entry, use 'cd -' (equivalent to 'cd -0').
@@ -167,7 +167,7 @@
:group 'eshell-dirs)
(defcustom eshell-last-dir-unique t
- "*If non-nil, `eshell-last-dir-ring' contains only unique entries."
+ "If non-nil, `eshell-last-dir-ring' contains only unique entries."
:type 'boolean
:group 'eshell-dirs)
=== modified file 'lisp/eshell/em-glob.el'
--- a/lisp/eshell/em-glob.el 2010-01-13 08:35:10 +0000
+++ b/lisp/eshell/em-glob.el 2010-09-25 21:51:55 +0000
@@ -63,39 +63,39 @@
;;; User Variables:
(defcustom eshell-glob-load-hook '(eshell-glob-initialize)
- "*A list of functions to run when `eshell-glob' is loaded."
+ "A list of functions to run when `eshell-glob' is loaded."
:type 'hook
:group 'eshell-glob)
(defcustom eshell-glob-include-dot-files nil
- "*If non-nil, glob patterns will match files beginning with a dot."
+ "If non-nil, glob patterns will match files beginning with a dot."
:type 'boolean
:group 'eshell-glob)
(defcustom eshell-glob-include-dot-dot t
- "*If non-nil, glob patterns that match dots will match . and .."
+ "If non-nil, glob patterns that match dots will match . and .."
:type 'boolean
:group 'eshell-glob)
(defcustom eshell-glob-case-insensitive (eshell-under-windows-p)
- "*If non-nil, glob pattern matching will ignore case."
+ "If non-nil, glob pattern matching will ignore case."
:type 'boolean
:group 'eshell-glob)
(defcustom eshell-glob-show-progress nil
- "*If non-nil, display progress messages during a recursive glob.
+ "If non-nil, display progress messages during a recursive glob.
This option slows down recursive glob processing by quite a bit."
:type 'boolean
:group 'eshell-glob)
(defcustom eshell-error-if-no-glob nil
- "*If non-nil, it is an error for a glob pattern not to match.
+ "If non-nil, it is an error for a glob pattern not to match.
This mimcs the behavior of zsh if non-nil, but bash if nil."
:type 'boolean
:group 'eshell-glob)
(defcustom eshell-glob-chars-list '(?\] ?\[ ?* ?? ?~ ?\( ?\) ?| ?# ?^)
- "*List of additional characters used in extended globbing."
+ "List of additional characters used in extended globbing."
:type '(repeat character)
:group 'eshell-glob)
@@ -117,7 +117,7 @@
(if (eq (aref str (1+ pos)) ?*)
"*" "+")) (+ pos 2))
(cons "*" (1+ pos))))))
- "*An alist for translation of extended globbing characters."
+ "An alist for translation of extended globbing characters."
:type '(repeat (cons character (choice regexp function)))
:group 'eshell-glob)
=== modified file 'lisp/eshell/em-hist.el'
--- a/lisp/eshell/em-hist.el 2010-01-13 08:35:10 +0000
+++ b/lisp/eshell/em-hist.el 2010-09-25 21:51:55 +0000
@@ -72,7 +72,7 @@
;;; User Variables:
(defcustom eshell-hist-load-hook '(eshell-hist-initialize)
- "*A list of functions to call when loading `eshell-hist'."
+ "A list of functions to call when loading `eshell-hist'."
:type 'hook
:group 'eshell-hist)
@@ -81,31 +81,31 @@
(function
(lambda ()
(remove-hook 'kill-emacs-hook 'eshell-save-some-history))))
- "*A hook that gets run when `eshell-hist' is unloaded."
+ "A hook that gets run when `eshell-hist' is unloaded."
:type 'hook
:group 'eshell-hist)
(defcustom eshell-history-file-name
(expand-file-name "history" eshell-directory-name)
- "*If non-nil, name of the file to read/write input history.
+ "If non-nil, name of the file to read/write input history.
See also `eshell-read-history' and `eshell-write-history'.
If it is nil, Eshell will use the value of HISTFILE."
:type 'file
:group 'eshell-hist)
(defcustom eshell-history-size 128
- "*Size of the input history ring. If nil, use envvar HISTSIZE."
+ "Size of the input history ring. If nil, use envvar HISTSIZE."
:type 'integer
:group 'eshell-hist)
(defcustom eshell-hist-ignoredups nil
- "*If non-nil, don't add input matching the last on the input ring.
+ "If non-nil, don't add input matching the last on the input ring.
This mirrors the optional behavior of bash."
:type 'boolean
:group 'eshell-hist)
(defcustom eshell-save-history-on-exit t
- "*Determine if history should be automatically saved.
+ "Determine if history should be automatically saved.
History is always preserved after sanely exiting an Eshell buffer.
However, when Emacs is being shut down, this variable determines
whether to prompt the user.
@@ -121,7 +121,7 @@
(function
(lambda (str)
(not (string-match "\\`\\s-*\\'" str))))
- "*Predicate for filtering additions to input history.
+ "Predicate for filtering additions to input history.
Takes one argument, the input. If non-nil, the input may be saved on
the input history list. Default is to save anything that isn't all
whitespace."
@@ -131,7 +131,7 @@
(put 'eshell-input-filter 'risky-local-variable t)
(defcustom eshell-hist-match-partial t
- "*If non-nil, movement through history is constrained by current input.
+ "If non-nil, movement through history is constrained by current input.
Otherwise, typing <M-p> and <M-n> will always go to the next history
element, regardless of any text on the command line. In that case,
<C-c M-r> and <C-c M-s> still offer that functionality."
@@ -139,25 +139,25 @@
:group 'eshell-hist)
(defcustom eshell-hist-move-to-end t
- "*If non-nil, move to the end of the buffer before cycling history."
+ "If non-nil, move to the end of the buffer before cycling history."
:type 'boolean
:group 'eshell-hist)
(defcustom eshell-hist-event-designator
"^!\\(!\\|-?[0-9]+\\|\\??[^:^$%*?]+\\??\\|#\\)"
- "*The regexp used to identifier history event designators."
+ "The regexp used to identifier history event designators."
:type 'regexp
:group 'eshell-hist)
(defcustom eshell-hist-word-designator
"^:?\\([0-9]+\\|[$^%*]\\)?\\(\\*\\|-[0-9]*\\|[$^%*]\\)?"
- "*The regexp used to identify history word designators."
+ "The regexp used to identify history word designators."
:type 'regexp
:group 'eshell-hist)
(defcustom eshell-hist-modifier
"^\\(:\\([hretpqx&g]\\|s/\\([^/]*\\)/\\([^/]*\\)/\\)\\)*"
- "*The regexp used to identity history modifiers."
+ "The regexp used to identity history modifiers."
:type 'regexp
:group 'eshell-hist)
@@ -174,7 +174,7 @@
([(meta ?n)] . eshell-next-matching-input-from-input)
([up] . eshell-previous-matching-input-from-input)
([down] . eshell-next-matching-input-from-input))
- "*History keys to bind differently if point is in input text."
+ "History keys to bind differently if point is in input text."
:type '(repeat (cons (vector :tag "Keys to bind"
(repeat :inline t sexp))
(function :tag "Command")))
=== modified file 'lisp/eshell/em-ls.el'
--- a/lisp/eshell/em-ls.el 2010-09-25 21:42:48 +0000
+++ b/lisp/eshell/em-ls.el 2010-09-25 21:51:55 +0000
@@ -54,24 +54,24 @@
(function
(lambda ()
(fset 'insert-directory eshell-ls-orig-insert-directory))))
- "*When unloading `eshell-ls', restore the definition of `insert-directory'."
+ "When unloading `eshell-ls', restore the definition of `insert-directory'."
:type 'hook
:group 'eshell-ls)
(defcustom eshell-ls-initial-args nil
- "*If non-nil, this list of args is included before any call to `ls'.
+ "If non-nil, this list of args is included before any call to `ls'.
This is useful for enabling human-readable format (-h), for example."
:type '(repeat :tag "Arguments" string)
:group 'eshell-ls)
(defcustom eshell-ls-dired-initial-args nil
- "*If non-nil, args is included before any call to `ls' in Dired.
+ "If non-nil, args is included before any call to `ls' in Dired.
This is useful for enabling human-readable format (-h), for example."
:type '(repeat :tag "Arguments" string)
:group 'eshell-ls)
(defcustom eshell-ls-use-in-dired nil
- "*If non-nil, use `eshell-ls' to read directories in Dired."
+ "If non-nil, use `eshell-ls' to read directories in Dired."
:set (lambda (symbol value)
(if value
(unless (and (boundp 'eshell-ls-use-in-dired)
@@ -86,24 +86,24 @@
:group 'eshell-ls)
(defcustom eshell-ls-default-blocksize 1024
- "*The default blocksize to use when display file sizes with -s."
+ "The default blocksize to use when display file sizes with -s."
:type 'integer
:group 'eshell-ls)
(defcustom eshell-ls-exclude-regexp nil
- "*Unless -a is specified, files matching this regexp will not be shown."
+ "Unless -a is specified, files matching this regexp will not be shown."
:type '(choice regexp (const nil))
:group 'eshell-ls)
(defcustom eshell-ls-exclude-hidden t
- "*Unless -a is specified, files beginning with . will not be shown.
+ "Unless -a is specified, files beginning with . will not be shown.
Using this boolean, instead of `eshell-ls-exclude-regexp', is both
faster and conserves more memory."
:type 'boolean
:group 'eshell-ls)
(defcustom eshell-ls-use-colors t
- "*If non-nil, use colors in file listings."
+ "If non-nil, use colors in file listings."
:type 'boolean
:group 'eshell-ls)
@@ -111,7 +111,7 @@
'((((class color) (background light)) (:foreground "Blue" :weight bold))
(((class color) (background dark)) (:foreground "SkyBlue" :weight bold))
(t (:weight bold)))
- "*The face used for highlight directories."
+ "The face used for highlight directories."
:group 'eshell-ls)
(define-obsolete-face-alias 'eshell-ls-directory-face
'eshell-ls-directory "22.1")
@@ -119,14 +119,14 @@
(defface eshell-ls-symlink
'((((class color) (background light)) (:foreground "Dark Cyan" :weight bold))
(((class color) (background dark)) (:foreground "Cyan" :weight bold)))
- "*The face used for highlight symbolic links."
+ "The face used for highlight symbolic links."
:group 'eshell-ls)
(define-obsolete-face-alias 'eshell-ls-symlink-face 'eshell-ls-symlink "22.1")
(defface eshell-ls-executable
'((((class color) (background light)) (:foreground "ForestGreen" :weight
bold))
(((class color) (background dark)) (:foreground "Green" :weight bold)))
- "*The face used for highlighting executables (not directories, though)."
+ "The face used for highlighting executables (not directories, though)."
:group 'eshell-ls)
(define-obsolete-face-alias 'eshell-ls-executable-face
'eshell-ls-executable "22.1")
@@ -134,14 +134,14 @@
(defface eshell-ls-readonly
'((((class color) (background light)) (:foreground "Brown"))
(((class color) (background dark)) (:foreground "Pink")))
- "*The face used for highlighting read-only files."
+ "The face used for highlighting read-only files."
:group 'eshell-ls)
(define-obsolete-face-alias 'eshell-ls-readonly-face 'eshell-ls-readonly
"22.1")
(defface eshell-ls-unreadable
'((((class color) (background light)) (:foreground "Grey30"))
(((class color) (background dark)) (:foreground "DarkGrey")))
- "*The face used for highlighting unreadable files."
+ "The face used for highlighting unreadable files."
:group 'eshell-ls)
(define-obsolete-face-alias 'eshell-ls-unreadable-face
'eshell-ls-unreadable "22.1")
@@ -149,21 +149,21 @@
(defface eshell-ls-special
'((((class color) (background light)) (:foreground "Magenta" :weight bold))
(((class color) (background dark)) (:foreground "Magenta" :weight bold)))
- "*The face used for highlighting non-regular files."
+ "The face used for highlighting non-regular files."
:group 'eshell-ls)
(define-obsolete-face-alias 'eshell-ls-special-face 'eshell-ls-special "22.1")
(defface eshell-ls-missing
'((((class color) (background light)) (:foreground "Red" :weight bold))
(((class color) (background dark)) (:foreground "Red" :weight bold)))
- "*The face used for highlighting non-existent file names."
+ "The face used for highlighting non-existent file names."
:group 'eshell-ls)
(define-obsolete-face-alias 'eshell-ls-missing-face 'eshell-ls-missing "22.1")
(defcustom eshell-ls-archive-regexp
(concat "\\.\\(t\\(a[rz]\\|gz\\)\\|arj\\|lzh\\|"
"zip\\|[zZ]\\|gz\\|bz2\\|xz\\|deb\\|rpm\\)\\'")
- "*A regular expression that matches names of file archives.
+ "A regular expression that matches names of file archives.
This typically includes both traditional archives and compressed
files."
:version "24.1" ; added xz
@@ -173,26 +173,26 @@
(defface eshell-ls-archive
'((((class color) (background light)) (:foreground "Orchid" :weight bold))
(((class color) (background dark)) (:foreground "Orchid" :weight bold)))
- "*The face used for highlighting archived and compressed file names."
+ "The face used for highlighting archived and compressed file names."
:group 'eshell-ls)
(define-obsolete-face-alias 'eshell-ls-archive-face 'eshell-ls-archive "22.1")
(defcustom eshell-ls-backup-regexp
"\\(\\`\\.?#\\|\\(\\.bak\\|~\\)\\'\\)"
- "*A regular expression that matches names of backup files."
+ "A regular expression that matches names of backup files."
:type 'regexp
:group 'eshell-ls)
(defface eshell-ls-backup
'((((class color) (background light)) (:foreground "OrangeRed"))
(((class color) (background dark)) (:foreground "LightSalmon")))
- "*The face used for highlighting backup file names."
+ "The face used for highlighting backup file names."
:group 'eshell-ls)
(define-obsolete-face-alias 'eshell-ls-backup-face 'eshell-ls-backup "22.1")
(defcustom eshell-ls-product-regexp
"\\.\\(elc\\|o\\(bj\\)?\\|a\\|lib\\|res\\)\\'"
- "*A regular expression that matches names of product files.
+ "A regular expression that matches names of product files.
Products are files that get generated from a source file, and hence
ought to be recreatable if they are deleted."
:type 'regexp
@@ -201,13 +201,13 @@
(defface eshell-ls-product
'((((class color) (background light)) (:foreground "OrangeRed"))
(((class color) (background dark)) (:foreground "LightSalmon")))
- "*The face used for highlighting files that are build products."
+ "The face used for highlighting files that are build products."
:group 'eshell-ls)
(define-obsolete-face-alias 'eshell-ls-product-face 'eshell-ls-product "22.1")
(defcustom eshell-ls-clutter-regexp
"\\(^texput\\.log\\|^core\\)\\'"
- "*A regular expression that matches names of junk files.
+ "A regular expression that matches names of junk files.
These are mainly files that get created for various reasons, but don't
really need to stick around for very long."
:type 'regexp
@@ -216,7 +216,7 @@
(defface eshell-ls-clutter
'((((class color) (background light)) (:foreground "OrangeRed" :weight bold))
(((class color) (background dark)) (:foreground "OrangeRed" :weight bold)))
- "*The face used for highlighting junk file names."
+ "The face used for highlighting junk file names."
:group 'eshell-ls)
(define-obsolete-face-alias 'eshell-ls-clutter-face 'eshell-ls-clutter "22.1")
@@ -250,7 +250,7 @@
(,(eval func) ,file)))))
(defcustom eshell-ls-highlight-alist nil
- "*This alist correlates test functions to color.
+ "This alist correlates test functions to color.
The format of the members of this alist is
(TEST-SEXP . FACE)
=== modified file 'lisp/eshell/em-pred.el'
--- a/lisp/eshell/em-pred.el 2010-01-13 08:35:10 +0000
+++ b/lisp/eshell/em-pred.el 2010-09-25 21:51:55 +0000
@@ -61,7 +61,7 @@
;;; User Variables:
(defcustom eshell-pred-load-hook '(eshell-pred-initialize)
- "*A list of functions to run when `eshell-pred' is loaded."
+ "A list of functions to run when `eshell-pred' is loaded."
:type 'hook
:group 'eshell-pred)
@@ -101,7 +101,7 @@
(?m . (eshell-pred-file-time ?m "modification" 5))
(?c . (eshell-pred-file-time ?c "change" 6))
(?L . (eshell-pred-file-size)))
- "*A list of predicates than can be applied to a globbing pattern.
+ "A list of predicates than can be applied to a globbing pattern.
The format of each entry is
(CHAR . PREDICATE-FUNC-SEXP)"
@@ -150,7 +150,7 @@
(eshell-pred-substitute t)
(error "`g' modifier cannot be used alone"))))
(?s . (eshell-pred-substitute)))
- "*A list of modifiers than can be applied to an argument expansion.
+ "A list of modifiers than can be applied to an argument expansion.
The format of each entry is
(CHAR ENTRYWISE-P MODIFIER-FUNC-SEXP)"
=== modified file 'lisp/eshell/em-prompt.el'
--- a/lisp/eshell/em-prompt.el 2010-01-13 08:35:10 +0000
+++ b/lisp/eshell/em-prompt.el 2010-09-25 21:51:55 +0000
@@ -39,7 +39,7 @@
;;; User Variables:
(defcustom eshell-prompt-load-hook '(eshell-prompt-initialize)
- "*A list of functions to call when loading `eshell-prompt'."
+ "A list of functions to call when loading `eshell-prompt'."
:type 'hook
:group 'eshell-prompt)
@@ -55,7 +55,7 @@
:group 'eshell-prompt)
(defcustom eshell-prompt-regexp "^[^#$\n]* [#$] "
- "*A regexp which fully matches your eshell prompt.
+ "A regexp which fully matches your eshell prompt.
This setting is important, since it affects how eshell will interpret
the lines that are passed to it.
If this variable is changed, all Eshell buffers must be exited and
@@ -64,7 +64,7 @@
:group 'eshell-prompt)
(defcustom eshell-highlight-prompt t
- "*If non-nil, Eshell should highlight the prompt."
+ "If non-nil, Eshell should highlight the prompt."
:type 'boolean
:group 'eshell-prompt)
@@ -72,20 +72,20 @@
'((((class color) (background light)) (:foreground "Red" :bold t))
(((class color) (background dark)) (:foreground "Pink" :bold t))
(t (:bold t)))
- "*The face used to highlight prompt strings.
+ "The face used to highlight prompt strings.
For highlighting other kinds of strings -- similar to shell mode's
behavior -- simply use an output filer which changes text properties."
:group 'eshell-prompt)
(define-obsolete-face-alias 'eshell-prompt-face 'eshell-prompt "22.1")
(defcustom eshell-before-prompt-hook nil
- "*A list of functions to call before outputting the prompt."
+ "A list of functions to call before outputting the prompt."
:type 'hook
:options '(eshell-begin-on-new-line)
:group 'eshell-prompt)
(defcustom eshell-after-prompt-hook nil
- "*A list of functions to call after outputting the prompt.
+ "A list of functions to call after outputting the prompt.
Note that if `eshell-scroll-show-maximum-output' is non-nil, then
setting `eshell-show-maximum-output' here won't do much. It depends
on whether the user wants the resizing to happen while output is
=== modified file 'lisp/eshell/em-rebind.el'
--- a/lisp/eshell/em-rebind.el 2010-01-13 08:35:10 +0000
+++ b/lisp/eshell/em-rebind.el 2010-09-25 21:51:55 +0000
@@ -43,7 +43,7 @@
;;; User Variables:
(defcustom eshell-rebind-load-hook '(eshell-rebind-initialize)
- "*A list of functions to call when loading `eshell-rebind'."
+ "A list of functions to call when loading `eshell-rebind'."
:type 'hook
:group 'eshell-rebind)
@@ -55,14 +55,14 @@
([delete] . eshell-delete-backward-char)
([(control ?w)] . backward-kill-word)
([(control ?u)] . eshell-kill-input))
- "*Bind some keys differently if point is in input text."
+ "Bind some keys differently if point is in input text."
:type '(repeat (cons (vector :tag "Keys to bind"
(repeat :inline t sexp))
(function :tag "Command")))
:group 'eshell-rebind)
(defcustom eshell-confine-point-to-input t
- "*If non-nil, do not allow the point to leave the current input.
+ "If non-nil, do not allow the point to leave the current input.
This is more difficult to do nicely in Emacs than one might think.
Basically, the `point-left' attribute is added to the input text, and
a function is placed on that hook to take the point back to
@@ -77,13 +77,13 @@
:group 'eshell-rebind)
(defcustom eshell-error-if-move-away t
- "*If non-nil, consider it an error to try to move outside current input.
+ "If non-nil, consider it an error to try to move outside current input.
This is default behavior of shells like bash."
:type 'boolean
:group 'eshell-rebind)
(defcustom eshell-remap-previous-input t
- "*If non-nil, remap input keybindings on previous prompts as well."
+ "If non-nil, remap input keybindings on previous prompts as well."
:type 'boolean
:group 'eshell-rebind)
@@ -132,7 +132,7 @@
forward-visible-line
forward-comment
forward-thing)
- "*A list of commands that cannot leave the input area."
+ "A list of commands that cannot leave the input area."
:type '(repeat function)
:group 'eshell-rebind)
=== modified file 'lisp/eshell/em-script.el'
--- a/lisp/eshell/em-script.el 2010-01-13 08:35:10 +0000
+++ b/lisp/eshell/em-script.el 2010-09-25 21:51:55 +0000
@@ -36,19 +36,19 @@
;;; User Variables:
(defcustom eshell-script-load-hook '(eshell-script-initialize)
- "*A list of functions to call when loading `eshell-script'."
+ "A list of functions to call when loading `eshell-script'."
:type 'hook
:group 'eshell-script)
(defcustom eshell-login-script (expand-file-name "login" eshell-directory-name)
- "*If non-nil, a file to invoke when starting up Eshell interactively.
+ "If non-nil, a file to invoke when starting up Eshell interactively.
This file should be a file containing Eshell commands, where comment
lines begin with '#'."
:type 'file
:group 'eshell-script)
(defcustom eshell-rc-script (expand-file-name "profile" eshell-directory-name)
- "*If non-nil, a file to invoke whenever Eshell is started.
+ "If non-nil, a file to invoke whenever Eshell is started.
This includes when running `eshell-command'."
:type 'file
:group 'eshell-script)
=== modified file 'lisp/eshell/em-smart.el'
--- a/lisp/eshell/em-smart.el 2010-01-13 08:35:10 +0000
+++ b/lisp/eshell/em-smart.el 2010-09-25 21:51:55 +0000
@@ -86,7 +86,7 @@
;;; User Variables:
(defcustom eshell-smart-load-hook '(eshell-smart-initialize)
- "*A list of functions to call when loading `eshell-smart'."
+ "A list of functions to call when loading `eshell-smart'."
:type 'hook
:group 'eshell-smart)
@@ -96,12 +96,12 @@
(lambda ()
(remove-hook 'window-configuration-change-hook
'eshell-refresh-windows))))
- "*A hook that gets run when `eshell-smart' is unloaded."
+ "A hook that gets run when `eshell-smart' is unloaded."
:type 'hook
:group 'eshell-smart)
(defcustom eshell-review-quick-commands nil
- "*If t, always review commands.
+ "If t, always review commands.
Reviewing means keeping point on the text of the command that was just
invoked, to allow corrections to be made easily.
@@ -124,12 +124,12 @@
yank-pop
yank-rectangle
yank)
- "*A list of commands which cause Eshell to jump to the end of buffer."
+ "A list of commands which cause Eshell to jump to the end of buffer."
:type '(repeat function)
:group 'eshell-smart)
(defcustom eshell-smart-space-goes-to-end t
- "*If non-nil, space will go to end of buffer when point-max is visible.
+ "If non-nil, space will go to end of buffer when point-max is visible.
That is, if a command is running and the user presses SPACE at a time
when the end of the buffer is visible, point will go to the end of the
buffer and smart-display will be turned off (that is, subsequently
@@ -148,7 +148,7 @@
:group 'eshell-smart)
(defcustom eshell-where-to-jump 'begin
- "*This variable indicates where point should jump to after a command.
+ "This variable indicates where point should jump to after a command.
The options are `begin', `after' or `end'."
:type '(radio (const :tag "Beginning of command" begin)
(const :tag "After command word" after)
=== modified file 'lisp/eshell/em-term.el'
--- a/lisp/eshell/em-term.el 2010-09-02 10:17:02 +0000
+++ b/lisp/eshell/em-term.el 2010-09-25 21:51:55 +0000
@@ -48,7 +48,7 @@
;;; User Variables:
(defcustom eshell-term-load-hook '(eshell-term-initialize)
- "*A list of functions to call when loading `eshell-term'."
+ "A list of functions to call when loading `eshell-term'."
:type 'hook
:group 'eshell-term)
@@ -58,19 +58,19 @@
"less" "more" ; M-x view-file
"lynx" "ncftp" ; w3.el, ange-ftp
"pine" "tin" "trn" "elm") ; GNUS!!
- "*A list of commands that present their output in a visual fashion."
+ "A list of commands that present their output in a visual fashion."
:type '(repeat string)
:group 'eshell-term)
(defcustom eshell-term-name "eterm"
- "*Name to use for the TERM variable when running visual commands.
+ "Name to use for the TERM variable when running visual commands.
See `term-term-name' in term.el for more information on how this is
used."
:type 'string
:group 'eshell-term)
(defcustom eshell-escape-control-x t
- "*If non-nil, allow <C-x> to be handled by Emacs key in visual buffers.
+ "If non-nil, allow <C-x> to be handled by Emacs key in visual buffers.
See the variable `eshell-visual-commands'. If this variable is set to
nil, <C-x> will send that control character to the invoked process."
:type 'boolean
=== modified file 'lisp/eshell/em-unix.el'
--- a/lisp/eshell/em-unix.el 2010-01-13 08:35:10 +0000
+++ b/lisp/eshell/em-unix.el 2010-09-25 21:51:55 +0000
@@ -55,84 +55,84 @@
:group 'eshell-module)
(defcustom eshell-unix-load-hook '(eshell-unix-initialize)
- "*A list of functions to run when `eshell-unix' is loaded."
+ "A list of functions to run when `eshell-unix' is loaded."
:type 'hook
:group 'eshell-unix)
(defcustom eshell-plain-grep-behavior nil
- "*If non-nil, standalone \"grep\" commands will behave normally.
+ "If non-nil, standalone \"grep\" commands will behave normally.
Standalone in this context means not redirected, and not on the
receiving side of a command pipeline."
:type 'boolean
:group 'eshell-unix)
(defcustom eshell-no-grep-available (not (eshell-search-path "grep"))
- "*If non-nil, no grep is available on the current machine."
+ "If non-nil, no grep is available on the current machine."
:type 'boolean
:group 'eshell-unix)
(defcustom eshell-plain-diff-behavior nil
- "*If non-nil, standalone \"diff\" commands will behave normally.
+ "If non-nil, standalone \"diff\" commands will behave normally.
Standalone in this context means not redirected, and not on the
receiving side of a command pipeline."
:type 'boolean
:group 'eshell-unix)
(defcustom eshell-plain-locate-behavior (featurep 'xemacs)
- "*If non-nil, standalone \"locate\" commands will behave normally.
+ "If non-nil, standalone \"locate\" commands will behave normally.
Standalone in this context means not redirected, and not on the
receiving side of a command pipeline."
:type 'boolean
:group 'eshell-unix)
(defcustom eshell-rm-removes-directories nil
- "*If non-nil, `rm' will remove directory entries.
+ "If non-nil, `rm' will remove directory entries.
Otherwise, `rmdir' is required."
:type 'boolean
:group 'eshell-unix)
(defcustom eshell-rm-interactive-query (= (user-uid) 0)
- "*If non-nil, `rm' will query before removing anything."
+ "If non-nil, `rm' will query before removing anything."
:type 'boolean
:group 'eshell-unix)
(defcustom eshell-mv-interactive-query (= (user-uid) 0)
- "*If non-nil, `mv' will query before overwriting anything."
+ "If non-nil, `mv' will query before overwriting anything."
:type 'boolean
:group 'eshell-unix)
(defcustom eshell-mv-overwrite-files t
- "*If non-nil, `mv' will overwrite files without warning."
+ "If non-nil, `mv' will overwrite files without warning."
:type 'boolean
:group 'eshell-unix)
(defcustom eshell-cp-interactive-query (= (user-uid) 0)
- "*If non-nil, `cp' will query before overwriting anything."
+ "If non-nil, `cp' will query before overwriting anything."
:type 'boolean
:group 'eshell-unix)
(defcustom eshell-cp-overwrite-files t
- "*If non-nil, `cp' will overwrite files without warning."
+ "If non-nil, `cp' will overwrite files without warning."
:type 'boolean
:group 'eshell-unix)
(defcustom eshell-ln-interactive-query (= (user-uid) 0)
- "*If non-nil, `ln' will query before overwriting anything."
+ "If non-nil, `ln' will query before overwriting anything."
:type 'boolean
:group 'eshell-unix)
(defcustom eshell-ln-overwrite-files nil
- "*If non-nil, `ln' will overwrite files without warning."
+ "If non-nil, `ln' will overwrite files without warning."
:type 'boolean
:group 'eshell-unix)
(defcustom eshell-default-target-is-dot nil
- "*If non-nil, the default destination for cp, mv or ln is `.'."
+ "If non-nil, the default destination for cp, mv or ln is `.'."
:type 'boolean
:group 'eshell-unix)
(defcustom eshell-du-prefer-over-ange nil
- "*Use Eshell's du in ange-ftp remote directories.
+ "Use Eshell's du in ange-ftp remote directories.
Otherwise, Emacs will attempt to use rsh to invoke du on the remote machine."
:type 'boolean
:group 'eshell-unix)
=== modified file 'lisp/eshell/esh-cmd.el'
--- a/lisp/eshell/esh-cmd.el 2010-01-13 08:35:10 +0000
+++ b/lisp/eshell/esh-cmd.el 2010-09-25 21:51:55 +0000
@@ -122,28 +122,28 @@
:group 'eshell)
(defcustom eshell-prefer-lisp-functions nil
- "*If non-nil, prefer Lisp functions to external commands."
+ "If non-nil, prefer Lisp functions to external commands."
:type 'boolean
:group 'eshell-cmd)
(defcustom eshell-lisp-regexp "\\([(`]\\|#'\\)"
- "*A regexp which, if matched at beginning of an argument, means Lisp.
+ "A regexp which, if matched at beginning of an argument, means Lisp.
Such arguments will be passed to `read', and then evaluated."
:type 'regexp
:group 'eshell-cmd)
(defcustom eshell-pre-command-hook nil
- "*A hook run before each interactive command is invoked."
+ "A hook run before each interactive command is invoked."
:type 'hook
:group 'eshell-cmd)
(defcustom eshell-post-command-hook nil
- "*A hook run after each interactive command is invoked."
+ "A hook run after each interactive command is invoked."
:type 'hook
:group 'eshell-cmd)
(defcustom eshell-prepare-command-hook nil
- "*A set of functions called to prepare a named command.
+ "A set of functions called to prepare a named command.
The command name and its argument are in `eshell-last-command-name'
and `eshell-last-arguments'. The functions on this hook can change
the value of these symbols if necessary.
@@ -154,7 +154,7 @@
:group 'eshell-cmd)
(defcustom eshell-named-command-hook nil
- "*A set of functions called before a named command is invoked.
+ "A set of functions called before a named command is invoked.
Each function will be passed the command name and arguments that were
passed to `eshell-named-command'.
@@ -180,7 +180,7 @@
(defcustom eshell-pre-rewrite-command-hook
'(eshell-no-command-conversion
eshell-subcommand-arg-values)
- "*A hook run before command rewriting begins.
+ "A hook run before command rewriting begins.
The terms of the command to be rewritten is passed as arguments, and
may be modified in place. Any return value is ignored."
:type 'hook
@@ -193,7 +193,7 @@
eshell-rewrite-sexp-command
eshell-rewrite-initial-subcommand
eshell-rewrite-named-command)
- "*A set of functions used to rewrite the command argument.
+ "A set of functions used to rewrite the command argument.
Once parsing of a command line is completed, the next step is to
rewrite the initial argument into something runnable.
@@ -207,14 +207,14 @@
:group 'eshell-cmd)
(defcustom eshell-post-rewrite-command-hook nil
- "*A hook run after command rewriting is finished.
+ "A hook run after command rewriting is finished.
Each function is passed the symbol containing the rewritten command,
which may be modified directly. Any return value is ignored."
:type 'hook
:group 'eshell-cmd)
(defcustom eshell-complex-commands '("ls")
- "*A list of commands names or functions, that determine complexity.
+ "A list of commands names or functions, that determine complexity.
That is, if a command is defined by a function named eshell/NAME,
and NAME is part of this list, it is invoked as a complex command.
Complex commands are always correct, but run much slower. If a
@@ -231,12 +231,12 @@
;;; User Variables:
(defcustom eshell-cmd-load-hook '(eshell-cmd-initialize)
- "*A hook that gets run when `eshell-cmd' is loaded."
+ "A hook that gets run when `eshell-cmd' is loaded."
:type 'hook
:group 'eshell-cmd)
(defcustom eshell-debug-command nil
- "*If non-nil, enable debugging code. SSLLOOWW.
+ "If non-nil, enable debugging code. SSLLOOWW.
This option is only useful for reporting bugs. If you enable it, you
will have to visit the file 'eshell-cmd.el' and run the command
\\[eval-buffer]."
@@ -247,7 +247,7 @@
'(eshell-named-command
eshell-lisp-command
eshell-process-identity)
- "*A list of functions which might return an ansychronous process.
+ "A list of functions which might return an ansychronous process.
If they return a process object, execution of the calling Eshell
command will wait for completion (in the background) before finishing
the command."
@@ -258,7 +258,7 @@
'((eshell-in-subcommand-p t)
(default-directory default-directory)
(process-environment (eshell-copy-environment)))
- "*A list of `let' bindings for subcommand environments."
+ "A list of `let' bindings for subcommand environments."
:type 'sexp
:group 'eshell-cmd)
=== modified file 'lisp/eshell/esh-ext.el'
--- a/lisp/eshell/esh-ext.el 2010-01-13 08:35:10 +0000
+++ b/lisp/eshell/esh-ext.el 2010-09-25 21:51:55 +0000
@@ -1,7 +1,7 @@
;;; esh-ext.el --- commands external to Eshell
-;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004,
-;; 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
+;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
+;; 2008, 2009, 2010 Free Software Foundation, Inc.
;; Author: John Wiegley <address@hidden>
@@ -48,17 +48,17 @@
;;; User Variables:
(defcustom eshell-ext-load-hook '(eshell-ext-initialize)
- "*A hook that gets run when `eshell-ext' is loaded."
+ "A hook that gets run when `eshell-ext' is loaded."
:type 'hook
:group 'eshell-ext)
(defcustom eshell-binary-suffixes exec-suffixes
- "*A list of suffixes used when searching for executable files."
+ "A list of suffixes used when searching for executable files."
:type '(repeat string)
:group 'eshell-ext)
(defcustom eshell-force-execution nil
- "*If non-nil, try to execute binary files regardless of permissions.
+ "If non-nil, try to execute binary files regardless of permissions.
This can be useful on systems like Windows, where the operating system
doesn't happen to honor the permission bits in certain cases; or in
cases where you want to associate an interpreter with a particular
@@ -96,7 +96,7 @@
(or (eshell-search-path "cmd.exe")
(eshell-search-path "command.com"))
shell-file-name))
- "*The name of the shell command to use for DOS/Windows batch files.
+ "The name of the shell command to use for DOS/Windows batch files.
This defaults to nil on non-Windows systems, where this variable is
wholly ignored."
:type '(choice file (const nil))
@@ -113,7 +113,7 @@
(defcustom eshell-interpreter-alist
(if (eshell-under-windows-p)
'(("\\.\\(bat\\|cmd\\)\\'" . eshell-invoke-batch-file)))
- "*An alist defining interpreter substitutions.
+ "An alist defining interpreter substitutions.
Each member is a cons cell of the form:
(MATCH . INTERPRETER)
@@ -134,7 +134,7 @@
:group 'eshell-ext)
(defcustom eshell-alternate-command-hook nil
- "*A hook run whenever external command lookup fails.
+ "A hook run whenever external command lookup fails.
If a functions wishes to provide an alternate command, they must throw
it using the tag `eshell-replace-command'. This is done because the
substituted command need not be external at all, and therefore must be
@@ -147,12 +147,12 @@
:group 'eshell-ext)
(defcustom eshell-command-interpreter-max-length 256
- "*The maximum length of any command interpreter string, plus args."
+ "The maximum length of any command interpreter string, plus args."
:type 'integer
:group 'eshell-ext)
(defcustom eshell-explicit-command-char ?*
- "*If this char occurs before a command name, call it externally.
+ "If this char occurs before a command name, call it externally.
That is, although `vi' may be an alias, `\vi' will always call the
external version."
:type 'character
=== modified file 'lisp/eshell/esh-io.el'
--- a/lisp/eshell/esh-io.el 2010-07-30 23:25:06 +0000
+++ b/lisp/eshell/esh-io.el 2010-09-25 21:51:55 +0000
@@ -73,12 +73,12 @@
;;; User Variables:
(defcustom eshell-io-load-hook '(eshell-io-initialize)
- "*A hook that gets run when `eshell-io' is loaded."
+ "A hook that gets run when `eshell-io' is loaded."
:type 'hook
:group 'eshell-io)
(defcustom eshell-number-of-handles 3
- "*The number of file handles that eshell supports.
+ "The number of file handles that eshell supports.
Currently this is standard input, output and error. But even all of
these Emacs does not currently support with asynchronous processes
\(which is what eshell uses so that you can continue doing work in
@@ -87,17 +87,17 @@
:group 'eshell-io)
(defcustom eshell-output-handle 1
- "*The index of the standard output handle."
+ "The index of the standard output handle."
:type 'integer
:group 'eshell-io)
(defcustom eshell-error-handle 2
- "*The index of the standard error handle."
+ "The index of the standard error handle."
:type 'integer
:group 'eshell-io)
(defcustom eshell-buffer-shorthand nil
- "*If non-nil, a symbol name can be used for a buffer in redirection.
+ "If non-nil, a symbol name can be used for a buffer in redirection.
If nil, redirecting to a buffer requires buffer name syntax. If this
variable is set, redirection directly to Lisp symbols will be
impossible.
@@ -110,7 +110,7 @@
:group 'eshell-io)
(defcustom eshell-print-queue-size 5
- "*The size of the print queue, for doing buffered printing.
+ "The size of the print queue, for doing buffered printing.
This is basically a speed enhancement, to avoid blocking the Lisp code
from executing while Emacs is redisplaying."
:type 'integer
@@ -127,7 +127,7 @@
(let ((x-select-enable-clipboard t))
(kill-new "")))
'eshell-clipboard-append) t))
- "*Map virtual devices name to Emacs Lisp functions.
+ "Map virtual devices name to Emacs Lisp functions.
If the user specifies any of the filenames above as a redirection
target, the function in the second element will be called.
=== modified file 'lisp/eshell/esh-mode.el'
--- a/lisp/eshell/esh-mode.el 2010-01-13 08:35:10 +0000
+++ b/lisp/eshell/esh-mode.el 2010-09-25 21:51:55 +0000
@@ -75,54 +75,54 @@
;;; User Variables:
(defcustom eshell-mode-unload-hook nil
- "*A hook that gets run when `eshell-mode' is unloaded."
+ "A hook that gets run when `eshell-mode' is unloaded."
:type 'hook
:group 'eshell-mode)
(defcustom eshell-mode-hook nil
- "*A hook that gets run when `eshell-mode' is entered."
+ "A hook that gets run when `eshell-mode' is entered."
:type 'hook
:group 'eshell-mode)
(defcustom eshell-first-time-mode-hook nil
- "*A hook that gets run the first time `eshell-mode' is entered.
+ "A hook that gets run the first time `eshell-mode' is entered.
That is to say, the first time during an Emacs session."
:type 'hook
:group 'eshell-mode)
(defcustom eshell-exit-hook '(eshell-query-kill-processes)
- "*A hook that is run whenever `eshell' is exited.
+ "A hook that is run whenever `eshell' is exited.
This hook is only run if exiting actually kills the buffer."
:type 'hook
:group 'eshell-mode)
(defcustom eshell-kill-on-exit t
- "*If non-nil, kill the Eshell buffer on the `exit' command.
+ "If non-nil, kill the Eshell buffer on the `exit' command.
Otherwise, the buffer will simply be buried."
:type 'boolean
:group 'eshell-mode)
(defcustom eshell-input-filter-functions nil
- "*Functions to call before input is processed.
+ "Functions to call before input is processed.
The input is contained in the region from `eshell-last-input-start' to
`eshell-last-input-end'."
:type 'hook
:group 'eshell-mode)
(defcustom eshell-send-direct-to-subprocesses nil
- "*If t, send any input immediately to a subprocess."
+ "If t, send any input immediately to a subprocess."
:type 'boolean
:group 'eshell-mode)
(defcustom eshell-expand-input-functions nil
- "*Functions to call before input is parsed.
+ "Functions to call before input is parsed.
Each function is passed two arguments, which bounds the region of the
current input text."
:type 'hook
:group 'eshell-mode)
(defcustom eshell-scroll-to-bottom-on-input nil
- "*Controls whether input to interpreter causes window to scroll.
+ "Controls whether input to interpreter causes window to scroll.
If nil, then do not scroll. If t or `all', scroll all windows showing
buffer. If `this', scroll only the selected window.
@@ -133,7 +133,7 @@
:group 'eshell-mode)
(defcustom eshell-scroll-to-bottom-on-output nil
- "*Controls whether interpreter output causes window to scroll.
+ "Controls whether interpreter output causes window to scroll.
If nil, then do not scroll. If t or `all', scroll all windows showing
buffer. If `this', scroll only the selected window. If `others',
scroll only those that are not the selected window.
@@ -147,7 +147,7 @@
:group 'eshell-mode)
(defcustom eshell-scroll-show-maximum-output t
- "*Controls how interpreter output causes window to scroll.
+ "Controls how interpreter output causes window to scroll.
If non-nil, then show the maximum output when the window is scrolled.
See variable `eshell-scroll-to-bottom-on-output' and function
@@ -156,7 +156,7 @@
:group 'eshell-mode)
(defcustom eshell-buffer-maximum-lines 1024
- "*The maximum size in lines for eshell buffers.
+ "The maximum size in lines for eshell buffers.
Eshell buffers are truncated from the top to be no greater than this
number, if the function `eshell-truncate-buffer' is on
`eshell-output-filter-functions'."
@@ -168,14 +168,14 @@
eshell-handle-control-codes
eshell-handle-ansi-color
eshell-watch-for-password-prompt)
- "*Functions to call before output is displayed.
+ "Functions to call before output is displayed.
These functions are only called for output that is displayed
interactively, and not for output which is redirected."
:type 'hook
:group 'eshell-mode)
(defcustom eshell-preoutput-filter-functions nil
- "*Functions to call before output is inserted into the buffer.
+ "Functions to call before output is inserted into the buffer.
These functions get one argument, a string containing the text to be
inserted. They return the string as it should be inserted."
:type 'hook
@@ -183,18 +183,18 @@
(defcustom eshell-password-prompt-regexp
"[Pp]ass\\(word\\|phrase\\).*:\\s *\\'"
- "*Regexp matching prompts for passwords in the inferior process.
+ "Regexp matching prompts for passwords in the inferior process.
This is used by `eshell-watch-for-password-prompt'."
:type 'regexp
:group 'eshell-mode)
(defcustom eshell-skip-prompt-function nil
- "*A function called from beginning of line to skip the prompt."
+ "A function called from beginning of line to skip the prompt."
:type '(choice (const nil) function)
:group 'eshell-mode)
(defcustom eshell-status-in-modeline t
- "*If non-nil, let the user know a command is running in the modeline."
+ "If non-nil, let the user know a command is running in the modeline."
:type 'boolean
:group 'eshell-mode)
=== modified file 'lisp/eshell/esh-proc.el'
--- a/lisp/eshell/esh-proc.el 2010-01-13 08:35:10 +0000
+++ b/lisp/eshell/esh-proc.el 2010-09-25 21:51:55 +0000
@@ -1,7 +1,7 @@
;;; esh-proc.el --- process management
-;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004,
-;; 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
+;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
+;; 2008, 2009, 2010 Free Software Foundation, Inc.
;; Author: John Wiegley <address@hidden>
@@ -40,27 +40,27 @@
;;; User Variables:
(defcustom eshell-proc-load-hook '(eshell-proc-initialize)
- "*A hook that gets run when `eshell-proc' is loaded."
+ "A hook that gets run when `eshell-proc' is loaded."
:type 'hook
:group 'eshell-proc)
(defcustom eshell-process-wait-seconds 0
- "*The number of seconds to delay waiting for a synchronous process."
+ "The number of seconds to delay waiting for a synchronous process."
:type 'integer
:group 'eshell-proc)
(defcustom eshell-process-wait-milliseconds 50
- "*The number of milliseconds to delay waiting for a synchronous process."
+ "The number of milliseconds to delay waiting for a synchronous process."
:type 'integer
:group 'eshell-proc)
(defcustom eshell-done-messages-in-minibuffer t
- "*If non-nil, subjob \"Done\" messages will display in minibuffer."
+ "If non-nil, subjob \"Done\" messages will display in minibuffer."
:type 'boolean
:group 'eshell-proc)
(defcustom eshell-delete-exited-processes t
- "*If nil, process entries will stick around until `jobs' is run.
+ "If nil, process entries will stick around until `jobs' is run.
This variable sets the buffer-local value of `delete-exited-processes'
in Eshell buffers.
@@ -81,12 +81,12 @@
(defcustom eshell-reset-signals
"^\\(interrupt\\|killed\\|quit\\|stopped\\)"
- "*If a termination signal matches this regexp, the terminal will be reset."
+ "If a termination signal matches this regexp, the terminal will be reset."
:type 'regexp
:group 'eshell-proc)
(defcustom eshell-exec-hook nil
- "*Called each time a process is exec'd by `eshell-gather-process-output'.
+ "Called each time a process is exec'd by `eshell-gather-process-output'.
It is passed one argument, which is the process that was just started.
It is useful for things that must be done each time a process is
executed in a eshell mode buffer (e.g., `process-kill-without-query').
@@ -96,7 +96,7 @@
:group 'eshell-proc)
(defcustom eshell-kill-hook '(eshell-reset-after-proc)
- "*Called when a process run by `eshell-gather-process-output' has ended.
+ "Called when a process run by `eshell-gather-process-output' has ended.
It is passed two arguments: the process that was just ended, and the
termination status (as a string). Note that the first argument may be
nil, in which case the user attempted to send a signal, but there was
@@ -418,12 +418,12 @@
result))
(defcustom eshell-kill-process-wait-time 5
- "*Seconds to wait between sending termination signals to a subprocess."
+ "Seconds to wait between sending termination signals to a subprocess."
:type 'integer
:group 'eshell-proc)
(defcustom eshell-kill-process-signals '(SIGINT SIGQUIT SIGKILL)
- "*Signals used to kill processes when an Eshell buffer exits.
+ "Signals used to kill processes when an Eshell buffer exits.
Eshell calls each of these signals in order when an Eshell buffer is
killed; if the process is still alive afterwards, Eshell waits a
number of seconds defined by `eshell-kill-process-wait-time', and
@@ -432,7 +432,7 @@
:group 'eshell-proc)
(defcustom eshell-kill-processes-on-exit nil
- "*If non-nil, kill active processes when exiting an Eshell buffer.
+ "If non-nil, kill active processes when exiting an Eshell buffer.
Emacs will only kill processes owned by that Eshell buffer.
If nil, ownership of background and foreground processes reverts to
=== modified file 'lisp/eshell/esh-test.el'
--- a/lisp/eshell/esh-test.el 2010-05-25 02:11:08 +0000
+++ b/lisp/eshell/esh-test.el 2010-09-25 21:51:55 +0000
@@ -43,7 +43,7 @@
(defface eshell-test-ok
'((((class color) (background light)) (:foreground "Green" :bold t))
(((class color) (background dark)) (:foreground "Green" :bold t)))
- "*The face used to highlight OK result strings."
+ "The face used to highlight OK result strings."
:group 'eshell-test)
(define-obsolete-face-alias 'eshell-test-ok-face 'eshell-test-ok "22.1")
@@ -51,12 +51,12 @@
'((((class color) (background light)) (:foreground "OrangeRed" :bold t))
(((class color) (background dark)) (:foreground "OrangeRed" :bold t))
(t (:bold t)))
- "*The face used to highlight FAILED result strings."
+ "The face used to highlight FAILED result strings."
:group 'eshell-test)
(define-obsolete-face-alias 'eshell-test-failed-face 'eshell-test-failed
"22.1")
(defcustom eshell-show-usage-metrics nil
- "*If non-nil, display different usage metrics for each Eshell command."
+ "If non-nil, display different usage metrics for each Eshell command."
:set (lambda (symbol value)
(if value
(add-hook 'eshell-mode-hook 'eshell-show-usage-metrics)
=== modified file 'lisp/eshell/esh-util.el'
--- a/lisp/eshell/esh-util.el 2010-09-25 21:42:48 +0000
+++ b/lisp/eshell/esh-util.el 2010-09-25 21:51:55 +0000
@@ -32,7 +32,7 @@
;;; User Variables:
(defcustom eshell-stringify-t t
- "*If non-nil, the string representation of t is 't'.
+ "If non-nil, the string representation of t is 't'.
If nil, t will be represented only in the exit code of the function,
and not printed as a string. This causes Lisp functions to behave
similarly to external commands, as far as successful result output."
@@ -40,45 +40,45 @@
:group 'eshell-util)
(defcustom eshell-group-file "/etc/group"
- "*If non-nil, the name of the group file on your system."
+ "If non-nil, the name of the group file on your system."
:type '(choice (const :tag "No group file" nil) file)
:group 'eshell-util)
(defcustom eshell-passwd-file "/etc/passwd"
- "*If non-nil, the name of the passwd file on your system."
+ "If non-nil, the name of the passwd file on your system."
:type '(choice (const :tag "No passwd file" nil) file)
:group 'eshell-util)
(defcustom eshell-hosts-file "/etc/hosts"
- "*The name of the /etc/hosts file."
+ "The name of the /etc/hosts file."
:type '(choice (const :tag "No hosts file" nil) file)
:group 'eshell-util)
(defcustom eshell-handle-errors t
- "*If non-nil, Eshell will handle errors itself.
+ "If non-nil, Eshell will handle errors itself.
Setting this to nil is offered as an aid to debugging only."
:type 'boolean
:group 'eshell-util)
(defcustom eshell-private-file-modes 384 ; umask 177
- "*The file-modes value to use for creating \"private\" files."
+ "The file-modes value to use for creating \"private\" files."
:type 'integer
:group 'eshell-util)
(defcustom eshell-private-directory-modes 448 ; umask 077
- "*The file-modes value to use for creating \"private\" directories."
+ "The file-modes value to use for creating \"private\" directories."
:type 'integer
:group 'eshell-util)
(defcustom eshell-tar-regexp
"\\.t\\(ar\\(\\.\\(gz\\|bz2\\|xz\\|Z\\)\\)?\\|gz\\|a[zZ]\\|z2\\)\\'"
- "*Regular expression used to match tar file names."
+ "Regular expression used to match tar file names."
:version "24.1" ; added xz
:type 'regexp
:group 'eshell-util)
(defcustom eshell-convert-numeric-arguments t
- "*If non-nil, converting arguments of numeric form to Lisp numbers.
+ "If non-nil, converting arguments of numeric form to Lisp numbers.
Numeric form is tested using the regular expression
`eshell-number-regexp'.
@@ -96,7 +96,7 @@
:group 'eshell-util)
(defcustom eshell-number-regexp "-?\\([0-9]*\\.\\)?[0-9]+\\(e[-0-9.]+\\)?"
- "*Regular expression used to match numeric arguments.
+ "Regular expression used to match numeric arguments.
If `eshell-convert-numeric-arguments' is non-nil, and an argument
matches this regexp, it will be converted to a Lisp number, using the
function `string-to-number'."
@@ -104,7 +104,7 @@
:group 'eshell-util)
(defcustom eshell-ange-ls-uids nil
- "*List of user/host/id strings, used to determine remote ownership."
+ "List of user/host/id strings, used to determine remote ownership."
:type '(repeat (cons :tag "Host for User/UID map"
(string :tag "Hostname")
(repeat (cons :tag "User/UID List"
=== modified file 'lisp/eshell/esh-var.el'
--- a/lisp/eshell/esh-var.el 2010-01-13 08:35:10 +0000
+++ b/lisp/eshell/esh-var.el 2010-09-25 21:51:55 +0000
@@ -1,7 +1,7 @@
;;; esh-var.el --- handling of variables
-;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004,
-;; 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
+;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
+;; 2008, 2009, 2010 Free Software Foundation, Inc.
;; Author: John Wiegley <address@hidden>
@@ -128,27 +128,27 @@
;;; User Variables:
(defcustom eshell-var-load-hook '(eshell-var-initialize)
- "*A list of functions to call when loading `eshell-var'."
+ "A list of functions to call when loading `eshell-var'."
:type 'hook
:group 'eshell-var)
(defcustom eshell-prefer-lisp-variables nil
- "*If non-nil, prefer Lisp variables to environment variables."
+ "If non-nil, prefer Lisp variables to environment variables."
:type 'boolean
:group 'eshell-var)
(defcustom eshell-complete-export-definition t
- "*If non-nil, completing names for `export' shows current definition."
+ "If non-nil, completing names for `export' shows current definition."
:type 'boolean
:group 'eshell-var)
(defcustom eshell-modify-global-environment nil
- "*If non-nil, using `export' changes Emacs's global environment."
+ "If non-nil, using `export' changes Emacs's global environment."
:type 'boolean
:group 'eshell-var)
(defcustom eshell-variable-name-regexp "[A-Za-z0-9_-]+"
- "*A regexp identifying what constitutes a variable name reference.
+ "A regexp identifying what constitutes a variable name reference.
Note that this only applies for '$NAME'. If the syntax '$<NAME>' is
used, then NAME can contain any character, including angle brackets,
if they are quoted with a backslash."
@@ -183,7 +183,7 @@
eshell-command-arguments
(eshell-apply-indices eshell-command-arguments
indices)))))
- "*This list provides aliasing for variable references.
+ "This list provides aliasing for variable references.
It is very similar in concept to what `eshell-user-aliases-list' does
for commands. Each member of this defines defines the name of a
command, and the Lisp value to return for that variable if it is
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Emacs-diffs] /srv/bzr/emacs/trunk r101621: Cosmetic doc fixes for eshell.,
Glenn Morris <=