Skip to content

Commit d617894

Browse files
committed
small cleanups and add examples of -0 to README.md
1 parent bd79d85 commit d617894

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ whitespace issues it fixes):
1212
# consistent whitespace from programs that generate text files
1313
dump_database_schema | wtf.py -o clean_output.sql
1414

15+
# summarize a bunch of files without actually editing them (-0)
16+
find . -name "*.txt" -exec wtf.py -0 {} \;
17+
1518
# in-place editing
1619
wtf.py -i file1.txt file2.txt file3.txt
1720
wtf.py -I.bak file1.txt file2.txt file3.txt # ditto, with backups
@@ -47,7 +50,7 @@ program instead!
4750
<a name="options"/>Whitespace issues addressed
4851
----------------------------------------------
4952

50-
WTF current fixes, or simply reports, a few common types of whitespace
53+
WTF currently fixes, or simply reports, a few common types of whitespace
5154
issues. Most of these issues offer three possible command-line options
5255
enabling the user to fix, report, or ignore the issue.
5356

@@ -100,7 +103,7 @@ Unless the `-q`/`--quiet` option is used, WTF will summarize each file
100103
processed in which any whitespace issues were found and/or fixed. With
101104
`-v` it will also report issue-free files.
102105

103-
$ wtf nightmare.txt > /dev/null
106+
$ wtf -0 nightmare.txt # -0 is equivalent to > /dev/null
104107
nightmare.txt LINE 8: WARNING: spaces followed by tabs in whitespace at beginning of line
105108
nightmare.txt:
106109
CHOPPED 1 lines with trailing space
@@ -109,11 +112,11 @@ processed in which any whitespace issues were found and/or fixed. With
109112
CHANGED 1 line endings which didn't match crlf from first line
110113
WARNED ABOUT 1 lines with tabs/spaces mix
111114

112-
WTF will return the following return codes on successful operation:
115+
WTF will return the following exit codes on successful operation:
113116

114-
* 0: no issues seen (or `-X`/`--no-exit-codes` specified)
115-
* 10: issues fixed
116-
* 20: unfixed issues seen
117+
* `0`: no issues seen (or `-X`/`--no-exit-codes` specified)
118+
* `10`: issues fixed
119+
* `20`: unfixed issues seen
117120

118121
Todo
119122
----
@@ -130,7 +133,7 @@ Anything else?
130133

131134
Author
132135
------
133-
&copy; Daniel Lenski <<dlenski@gmail.com>> (2014-)
136+
&copy; Daniel Lenski <<dlenski@gmail.com>> (2014-2015)
134137

135138
License
136139
-------

0 commit comments

Comments
 (0)