mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updates to readme based on feedback.

Browse Source
This commit is contained in:
Mark Story 2016-01-23 11:33:50 -05:00
parent 561323e4cd
commit 2ffb5fde9d
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -53,10 +53,10 @@ binary and library targets of your crate.
You'll probably want to specify the write mode. Currently, there are modes for
diff, replace, overwrite, display, coverage, and checkstyle.
* `replace` Is the default and overwrites the original files after renaming them.
* `overwrite` rustfmt does not backup the source files.
* `display` Will print the formatted file to stdout.
* `diff` Will print a diff between the current file and formatted file to stdout.
* `replace` Is the default and overwrites the original files after creating backups of the files.
* `overwrite` Overwrites the original files _without_ creating backups.
* `display` Will print the formatted files to stdout.
* `diff` Will print a diff between the original files and formatted files to stdout.
* `checkstyle` Will output the lines that need to be corrected as a checkstyle XML file,
that can be used by tools like Jenkins.