From 561323e4cdf9fa2cd5db444091c960a8e00765db Mon Sep 17 00:00:00 2001 From: Mark Story Date: Fri, 22 Jan 2016 22:33:59 -0500 Subject: [PATCH] Update the README concerning write modes. Add checkstyle and more detail on each of the write modes. --- README.md | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index e69a4564556c..b8344ac770cd 100644 --- a/README.md +++ b/README.md @@ -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 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. +* `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.