squiid/rust
1
0
Fork 0
Code Issues Pull requests Projects Activity

Merge pull request #782 from markstory/readme-checkstyle

Browse source 
Update the README concerning write modes.
This commit is contained in:
Nick Cameron 2016-01-26 06:53:47 +13:00
commit 6a077bee00
1 changed files with 10 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -51,14 +51,17 @@ read data from stdin. Alternatively, you can use `cargo fmt` to format all
binary and library targets of your crate.
You'll probably want to specify the write mode. Currently, there are modes for
replace, overwrite, display, and coverage. The replace mode is the default
and overwrites the original files after renaming them. In overwrite mode,
rustfmt does not backup the source files. To print the output to stdout, use the
display mode. The write mode can be set by passing the `--write-mode` flag on
the command line.
diff, replace, overwrite, display, coverage, and checkstyle.
`rustfmt filename --write-mode=display` prints the output of rustfmt to the
screen, for example.
* `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.
The write mode can be set by passing the `--write-mode` flag on
the command line. For example `rustfmt --write-mode=display src/filename.rs`
You can run `rustfmt --help` for more information.