X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=README.md;h=9c7a1c4bc341bed77ce3ee362a8eea5d01ad7974;hb=2323cbc2311d2b907b62d5dc58970756bfb3cbc0;hp=cfada1a84f6c9580712abedbbdd82a0137f43451;hpb=6739dbe77df4cbe211c286f31fbdb7bbf2e4265c;p=rust.git

diff --git a/README.md b/README.md
index cfada1a84f6..9c7a1c4bc34 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# rustfmt [![Build Status](https://travis-ci.org/rust-lang-nursery/rustfmt.svg)](https://travis-ci.org/rust-lang-nursery/rustfmt) [![Build Status](https://ci.appveyor.com/api/projects/status/github/rust-lang-nursery/rustfmt?svg=true)](https://ci.appveyor.com/project/nrc/rustfmt) [![crates.io](https://img.shields.io/crates/v/rustfmt-nightly.svg)](https://crates.io/crates/rustfmt-nightly) [![Travis Configuration Status](https://img.shields.io/travis/davidalber/rustfmt-travis.svg?label=travis%20example)](https://travis-ci.org/davidalber/rustfmt-travis)
+# rustfmt [![Build Status](https://travis-ci.com/rust-lang/rustfmt.svg?branch=master)](https://travis-ci.com/rust-lang/rustfmt) [![Build Status](https://ci.appveyor.com/api/projects/status/github/rust-lang/rustfmt?svg=true)](https://ci.appveyor.com/project/rust-lang-libs/rustfmt) [![crates.io](https://img.shields.io/crates/v/rustfmt-nightly.svg)](https://crates.io/crates/rustfmt-nightly) [![Travis Configuration Status](https://img.shields.io/travis/davidalber/rustfmt-travis.svg?label=travis%20example)](https://travis-ci.org/davidalber/rustfmt-travis)
 
 A tool for formatting Rust code according to style guidelines.
 
@@ -15,31 +15,34 @@ the "travis example" badge above.
 
 You can run `rustfmt` with Rust 1.24 and above.
 
+### On the Stable toolchain
+
 To install:
 
-```
-rustup component add rustfmt-preview
+```sh
+rustup component add rustfmt
 ```
 
-to run on a cargo project in the current working directory:
+To run on a cargo project in the current working directory:
 
-```
+```sh
 cargo fmt
 ```
 
-For the latest and greatest `rustfmt` (nightly required):
-```
-rustup component add rustfmt-preview --toolchain nightly
-```
-To run:
-```
-cargo +nightly fmt
+### On the Nightly toolchain
+
+For the latest and greatest `rustfmt`, nightly is required.
+
+To install:
+
+```sh
+rustup component add rustfmt --toolchain nightly
 ```
 
-To format code that requires edition 2018, create a `rustfmt.toml` [configuration](#configuring-rustfmt) file containing:
+To run on a cargo project in the current working directory:
 
-```toml
-edition = "2018"
+```sh
+cargo +nightly fmt
 ```
 
 ## Limitations
@@ -73,15 +76,15 @@ because in the future Rustfmt might work on code where it currently does not):
 
 ## Installation
 
-```
-rustup component add rustfmt-preview
+```sh
+rustup component add rustfmt
 ```
 
 ## Installing from source
 
 To install from source (nightly required), first checkout to the tag or branch you want to install, then issue
 
-```
+```sh
 cargo install --path .
 ```
 
@@ -98,7 +101,7 @@ just need to run on the root file (usually mod.rs or lib.rs). Rustfmt can also
 read data from stdin. Alternatively, you can use `cargo fmt` to format all
 binary and library targets of your crate.
 
-You can run `rustfmt --help` for information about argument.
+You can run `rustfmt --help` for information about available arguments.
 
 When running with `--check`, Rustfmt will exit with `0` if Rustfmt would not
 make any formatting changes to the input, and `1` if Rustfmt would make changes.
@@ -131,11 +134,11 @@ A minimal Travis setup could look like this (requires Rust 1.24.0 or greater):
 ```yaml
 language: rust
 before_script:
-- rustup component add rustfmt-preview
+- rustup component add rustfmt
 script:
-- cargo fmt --all -- --check
 - cargo build
 - cargo test
+- cargo fmt --all -- --check
 ```
 
 See [this blog post](https://medium.com/@ag_dubs/enforcing-style-in-ci-for-rust-projects-18f6b09ec69d)
@@ -157,7 +160,7 @@ 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
 --help=config` for the options which are available, or if you prefer to see
-visual style previews, [Configurations.md](Configurations.md).
+visual style previews, [GitHub page](https://rust-lang.github.io/rustfmt/).
 
 By default, Rustfmt uses a style which conforms to the [Rust style guide][style
 guide] that has been formalized through the [style RFC
@@ -165,16 +168,32 @@ process][fmt rfcs].
 
 Configuration options are either stable or unstable. Stable options can always
 be used, while unstable ones are only available on a nightly toolchain, and opt-in.
-See [Configurations.md](Configurations.md) for details.
+See [GitHub page](https://rust-lang.github.io/rustfmt/) for details.
+
+### Rust's Editions
 
+Rustfmt is able to pick up the edition used by reading the `Cargo.toml` file if
+executed through the Cargo's formatting tool `cargo fmt`. Otherwise, the edition
+needs to be specified in `rustfmt.toml`, e.g., with `edition = "2018"`.
 
 ## Tips
 
-* For things you do not want rustfmt to mangle, use one of
+* For things you do not want rustfmt to mangle, use `#[rustfmt::skip]`
+* To prevent rustfmt from formatting a macro or an attribute,
+  use `#[rustfmt::skip::macros(target_macro_name)]` or
+  `#[rustfmt::skip::attributes(target_attribute_name)]`
+
+  Example:
 
     ```rust
-    #[rustfmt::skip]  // requires nightly Rust and #![feature(tool_attributes)] in crate root
-    #[cfg_attr(rustfmt, rustfmt_skip)]  // works in stable
+    #![rustfmt::skip::attributes(custom_attribute)]
+
+    #[custom_attribute(formatting , here , should , be , Skipped)]
+    #[rustfmt::skip::macros(html)]
+    fn main() {
+        let macro_result1 = html! { <div>
+    Hello</div>
+        }.to_string();
     ```
 * 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
@@ -189,7 +208,7 @@ See [Configurations.md](Configurations.md) for details.
 
   Example:
 
-  ```
+  ```sh
   cargo fmt -- --emit files
   ```
 
@@ -201,6 +220,7 @@ See [Configurations.md](Configurations.md) for details.
   | stdout | writes output to stdout | No |
   | coverage | displays how much of the input file was processed | Yes |
   | checkstyle | emits in a checkstyle format | Yes |
+  | json | emits diffs in a json format | Yes |
 
 ## License
 
@@ -210,5 +230,5 @@ Apache License (Version 2.0).
 See [LICENSE-APACHE](LICENSE-APACHE) and [LICENSE-MIT](LICENSE-MIT) for details.
 
 [rust]: https://github.com/rust-lang/rust
-[fmt rfcs]: https://github.com/rust-lang-nursery/fmt-rfcs
-[style guide]: https://github.com/rust-lang-nursery/fmt-rfcs/blob/master/guide/guide.md
+[fmt rfcs]: https://github.com/rust-dev-tools/fmt-rfcs
+[style guide]: https://github.com/rust-dev-tools/fmt-rfcs/blob/master/guide/guide.md