nightly-0.99.3

[rust.git] / README.md

diff --git a/README.md b/README.md
index 53b7e2757add80db5c1b54242978d26f34f7d13b..04f9f2f928c8de6ed1fc9743b41e90303bdede6e 100644 (file)
--- a/README.md
+++ b/README.md
@@ -6,28 +6,14 @@ If you'd like to help out (and you should, it's a fun project!), see
 [Contributing.md](Contributing.md) and our [Code of
 Conduct](CODE_OF_CONDUCT.md).
 
 [Contributing.md](Contributing.md) and our [Code of
 Conduct](CODE_OF_CONDUCT.md).
 

-We are changing the default style used by rustfmt. There is an ongoing [RFC
-process][fmt rfcs]. The last version using the old style was 0.8.6. From 0.9
-onwards, the RFC style is the default. If you want the old style back, you can
-use [legacy-rustfmt.toml](legacy-rustfmt.toml) as your rustfmt.toml.
-
-The current `master` branch uses libsyntax (part of the compiler). It is
-published as `rustfmt-nightly`. The `syntex` branch uses Syntex instead of
-libsyntax, it is published (for now) as `rustfmt`. Most development happens on
-the `master` branch, however, this only supports nightly toolchains. If you use
-stable or beta Rust toolchains, you must use the Syntex version (which is likely
-to be a bit out of date). Version 0.1 of rustfmt-nightly is forked from version
-0.9 of the syntex branch.
-

 You can use rustfmt in Travis CI builds. We provide a minimal Travis CI
 configuration (see [here](#checking-style-on-a-ci-server)) and verify its status
 using another repository. The status of that repository's build is reported by
 the "travis example" badge above.
 
 You can use rustfmt in Travis CI builds. We provide a minimal Travis CI
 configuration (see [here](#checking-style-on-a-ci-server)) and verify its status
 using another repository. The status of that repository's build is reported by
 the "travis example" badge above.
 

-

 ## Quick start
 
 ## Quick start
 

-You can use `rustfmt` on Rust 1.24 and above.
+You can run `rustfmt` with Rust 1.24 and above.

 
 To install:
 
 
 To install:
 


@@ -50,6 +36,12 @@ To run:
 cargo +nightly fmt
 ```
 
 cargo +nightly fmt
 ```
 

+To format code that requires edition 2018, create a `rustfmt.toml` [configuration](#configuring-rustfmt) file containing:
+
+```toml
+edition = "Edition2018"
+```
+

 ## Limitations
 
 Rustfmt tries to work on as much Rust code as possible, sometimes, the code
 ## Limitations
 
 Rustfmt tries to work on as much Rust code as possible, sometimes, the code


@@ -88,6 +80,7 @@ rustup component add rustfmt-preview
 ## Installing from source
 
 To install from source (nightly required), first checkout to the tag or branch you want to install, then issue
 ## Installing from source
 
 To install from source (nightly required), first checkout to the tag or branch you want to install, then issue

+

 ```
 cargo install --path .
 ```
 ```
 cargo install --path .
 ```


@@ -164,7 +157,7 @@ notes above on running rustfmt.
 Rustfmt is designed to be very configurable. You can create a TOML file called
 `rustfmt.toml` or `.rustfmt.toml`, place it in the project or any other parent
 directory and it will apply the options in that file. See `rustfmt
 Rustfmt is designed to be very configurable. You can create a TOML file called
 `rustfmt.toml` or `.rustfmt.toml`, place it in the project or any other parent
 directory and it will apply the options in that file. See `rustfmt

---config-help` for the options which are available, or if you prefer to see
+--help=config` for the options which are available, or if you prefer to see

 visual style previews, [Configurations.md](Configurations.md).
 
 By default, Rustfmt uses a style which conforms to the [Rust style guide][style
 visual style previews, [Configurations.md](Configurations.md).
 
 By default, Rustfmt uses a style which conforms to the [Rust style guide][style


@@ -187,7 +180,7 @@ See [Configurations.md](Configurations.md) for details.
 * When you run rustfmt, place a file named `rustfmt.toml` or `.rustfmt.toml` in
   target file directory or its parents to override the default settings of
   rustfmt. You can generate a file containing the default configuration with
 * When you run rustfmt, place a file named `rustfmt.toml` or `.rustfmt.toml` in
   target file directory or its parents to override the default settings of
   rustfmt. You can generate a file containing the default configuration with

-  `rustfmt --dump-default-config rustfmt.toml` and customize as needed.
+  `rustfmt --print-config default rustfmt.toml` and customize as needed.

 * After successful compilation, a `rustfmt` executable can be found in the
   target directory.
 * If you're having issues compiling Rustfmt (or compile errors when trying to
 * After successful compilation, a `rustfmt` executable can be found in the
   target directory.
 * If you're having issues compiling Rustfmt (or compile errors when trying to


@@ -216,6 +209,23 @@ See [Configurations.md](Configurations.md) for details.
 
   (Substitute `x86_64` by `i686` and `gnu` by `msvc` depending on which version of rustc was used to install rustfmt).
 
 
   (Substitute `x86_64` by `i686` and `gnu` by `msvc` depending on which version of rustc was used to install rustfmt).
 

+* You can change the way rustfmt emits the changes with the --emit flag:
+
+  Example:
+
+  ```
+  cargo fmt --emit files
+  ```
+
+  Options:
+
+  | Flag |Description| Nightly Only |
+  |:---:|:---:|:---:|
+  | files | overwrites output to files | No |
+  | stdout | writes output to stdout | No | 
+  | coverage | displays how much of the input file was processed | Yes |
+  | checkstyle | emits in a checkstyle format | Yes |
+

 ## License
 
 Rustfmt is distributed under the terms of both the MIT license and the
 ## License
 
 Rustfmt is distributed under the terms of both the MIT license and the