NOTE: This patch has been committed. The version below is
informational only (whitespace differences have been removed).
skip(a)pobox.com wrote:
The whitespace module is missing whitespace-describe but the
docstring
for whitespace-cleanup refers the user to it as a way to get a summary
of the various whitespace problems the module purports to solve.
Fixed (see patch below). Sorry, Norbert !! :-/
xemacs-packages/text-modes/ChangeLog addition:
2007-05-02 Didier Verna <didier(a)xemacs.org>
* whitespace.el (whitespace-buffer): Fix and improve the
documentation string.
* whitespace.el (whitespace-cleanup): Advertise
`whitespace-buffer' for whitespace problems description.
XEmacs Packages source patch:
Diff command: cvs -q diff -u -t -b -B -w
Files affected: xemacs-packages/text-modes/whitespace.el
Index: xemacs-packages/text-modes/whitespace.el
===================================================================
RCS file: /pack/xemacscvs/XEmacs/packages/xemacs-packages/text-modes/whitespace.el,v
retrieving revision 1.4
diff -u -u -t -b -B -w -r1.4 whitespace.el
--- xemacs-packages/text-modes/whitespace.el 30 Apr 2007 15:50:35 -0000 1.4
+++ xemacs-packages/text-modes/whitespace.el 2 May 2007 08:12:12 -0000
@@ -6,7 +6,7 @@
;; Maintainer: Didier Verna <didier(a)xemacs.org>
;; Keywords: convenience
-;; $Id: whitespace.el,v 1.3 2005/03/25 17:09:08 aidan Exp $
+;; $Id: whitespace.el,v 1.4 2007/04/30 15:50:35 didierv Exp $
;; This file is part of GNU Emacs.
;; GNU Emacs is free software; you can redistribute it and/or modify
@@ -509,17 +509,19 @@
;;;###autoload
(defun whitespace-buffer (&optional quiet)
"Find five different types of white spaces in buffer.
+
These are:
-1. Leading space \(empty lines at the top of a file\).
-2. Trailing space \(empty lines at the end of a file\).
-3. Indentation space \(8 or more spaces, that should be replaced with TABS\).
-4. Spaces followed by a TAB. \(Almost always, we never want that\).
-5. Spaces or TABS at the end of a line.
-
-Check for whitespace only if this buffer really contains a non-empty file
-and:
-1. the major mode is one of the whitespace-modes, or
-2. `whitespace-buffer' was explicitly called with a prefix argument."
+1. Leading space: empty lines at the top of a file (should be removed).
+2. Trailing space: empty lines at the end of a file (should be removed).
+3. Indentation space: 8 or more spaces at beginning of line
+ (should be replaced with TABS).
+4. Spaces followed by a TAB (should be replaced by TABS).
+5. Spaces or TABS at the end of a line (should be removed).
+
+Check for whitespace only if buffer really contains a non-empty file, and:
+1. the file matches one item of `whitespace-files', or
+2. the major mode matches one item of `whitespace-modes', or
+3. `whitespace-buffer' was explicitly called with a prefix argument."
(interactive)
(let ((whitespace-error nil))
(whitespace-check-whitespace-mode current-prefix-arg)
@@ -624,7 +626,7 @@
(defun whitespace-cleanup ()
"Cleanup the five different kinds of whitespace problems.
-Use \\[describe-function] whitespace-describe to read a summary of the
+Use \`\\[describe-function] whitespace-buffer' to read a summary of the
whitespace problems."
(interactive)
;; If this buffer really contains a file, then run, else quit.
--
Read the Jazz Blog !!
http://jazzblog.didierverna.com
Didier Verna, didier(a)lrde.epita.fr,
http://www.lrde.epita.fr/~didier
EPITA / LRDE, 14-16 rue Voltaire Tel.+33 (1) 44 08 01 85
94276 Le Kremlin-Bicêtre, France Fax.+33 (1) 53 14 59 22 didier(a)xemacs.org
_______________________________________________
XEmacs-Beta mailing list
XEmacs-Beta(a)xemacs.org
http://calypso.tux.org/cgi-bin/mailman/listinfo/xemacs-beta