aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorReuben Thomas2014-05-29 23:43:26 +0100
committerReuben Thomas2014-05-29 23:43:26 +0100
commitb0877c4488a7a10e32e5602fc0b070222e773c02 (patch)
tree986f1f3a017d67be1f055514d8cfa3897b470059
parent6ddcaa8f0596c4fc3d7f90fedf75578244a49320 (diff)
downloademacs-b0877c4488a7a10e32e5602fc0b070222e773c02.tar.gz
emacs-b0877c4488a7a10e32e5602fc0b070222e773c02.zip
Improve documentation for whitespace-report{,-region}
* whitespace.el (whitespace-report-region): Simplify documentation. (whitespace-report): Refer to whitespace-report-region's documentation. This commit message also covers the previous commit, which was erroneously committed with the log message "."; sorry.
-rw-r--r--lisp/ChangeLog5
-rw-r--r--lisp/whitespace.el31
2 files changed, 5 insertions, 31 deletions
diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index 6eb3aba5d22..12b194483ff 100644
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,6 +1,9 @@
12014-05-29 Reuben Thomas <rrt@sc3d.org> 12014-05-29 Reuben Thomas <rrt@sc3d.org>
2 2
3 * whitespace.el (whitespace-report): Simplify documentation. 3 * whitespace.el (whitespace-report-region): Simplify
4 documentation.
5 (whitespace-report): Refer to whitespace-report-region's
6 documentation.
4 7
52014-05-29 Stefan Monnier <monnier@iro.umontreal.ca> 82014-05-29 Stefan Monnier <monnier@iro.umontreal.ca>
6 9
diff --git a/lisp/whitespace.el b/lisp/whitespace.el
index 72919340a29..c67733623dc 100644
--- a/lisp/whitespace.el
+++ b/lisp/whitespace.el
@@ -1719,36 +1719,7 @@ It is a cons of strings, where the car part is used when
1719(defun whitespace-report (&optional force report-if-bogus) 1719(defun whitespace-report (&optional force report-if-bogus)
1720 "Report some whitespace problems in buffer. 1720 "Report some whitespace problems in buffer.
1721 1721
1722Return nil if there is no whitespace problem; otherwise, return 1722Perform `whitespace-report-region' on the current buffer."
1723non-nil.
1724
1725If FORCE is non-nil or \\[universal-argument] was pressed just
1726before calling `whitespace-report' interactively, it forces
1727`whitespace-style' to have:
1728
1729 empty
1730 trailing
1731 indentation
1732 space-before-tab
1733 space-after-tab
1734
1735If REPORT-IF-BOGUS is non-nil, it reports only when there are any
1736whitespace problems in buffer.
1737
1738Report if some of the following whitespace problems exist:
1739
1740 empty 1. empty lines at beginning of buffer.
1741 empty 2. empty lines at end of buffer.
1742 trailing 3. SPACEs or TABs at end of line.
1743 space-before-tab 4. SPACEs before TAB.
1744 space-after-tab 5. 8 or more SPACEs after TAB.
1745 indentation 6. If `indent-tabs-mode':
1746 8 or more SPACEs at beginning of line
1747 else: TABS at beginning of line.
1748
1749See `whitespace-style' for documentation.
1750See also `whitespace-cleanup' and `whitespace-cleanup-region' for
1751cleaning up these problems."
1752 (interactive (list current-prefix-arg)) 1723 (interactive (list current-prefix-arg))
1753 (whitespace-report-region (point-min) (point-max) 1724 (whitespace-report-region (point-min) (point-max)
1754 force report-if-bogus)) 1725 force report-if-bogus))