Merge pull request #3145 from otavio/allow-failure-for-crater

[rust.git] / README.md

diff --git a/README.md b/README.md
index e7f48f035d3112a0c498c3bdd06df795cf661ae1..0af1a94080d9f1dff098c75f5fa9b5ddf4b2813a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -36,12 +36,6 @@ To run:
 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
@@ -115,6 +109,7 @@ completed without error (whether or not changes were made).
 * [Sublime Text 3](https://packagecontrol.io/packages/RustFmt)
 * [Atom](atom.md)
 * Visual Studio Code using [vscode-rust](https://github.com/editor-rs/vscode-rust), [vsc-rustfmt](https://github.com/Connorcpu/vsc-rustfmt) or [rls_vscode](https://github.com/jonathandturner/rls_vscode) through RLS.
+* [IntelliJ or CLion](intellij.md)
 
 
 ## Checking style on a CI server
@@ -129,8 +124,6 @@ A minimal Travis setup could look like this (requires Rust 1.24.0 or greater):
 
 ```yaml
 language: rust
-rust:
-- nightly
 before_script:
 - rustup component add rustfmt-preview
 script:
@@ -157,7 +150,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
---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
@@ -171,12 +164,7 @@ See [Configurations.md](Configurations.md) for details.
 
 ## Tips
 
-* For things you do not want rustfmt to mangle, use one of
-
-    ```rust
-    #[rustfmt::skip]  // requires nightly Rust and #![feature(tool_attributes)] in crate root
-    #[cfg_attr(rustfmt, rustfmt_skip)]  // works in stable
-    ```
+* For things you do not want rustfmt to mangle, use `#[rustfmt::skip]`
 * 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
@@ -186,35 +174,12 @@ See [Configurations.md](Configurations.md) for details.
 * If you're having issues compiling Rustfmt (or compile errors when trying to
   install), make sure you have the most recent version of Rust installed.
 
-* If you get an error like `error while loading shared libraries` while starting
-  up rustfmt you should try the following:
-
-  On Linux:
-
-  ```
-  export LD_LIBRARY_PATH=$(rustc --print sysroot)/lib:$LD_LIBRARY_PATH
-  ```
-
-  On MacOS:
-
-  ```
-  export DYLD_LIBRARY_PATH=$(rustc --print sysroot)/lib:$DYLD_LIBRARY_PATH
-  ```
-
-  On Windows (Git Bash/Mingw):
-
-  ```
-  export PATH=$(rustc --print sysroot)/lib/rustlib/x86_64-pc-windows-gnu/lib/:$PATH
-  ```
-
-  (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
+  cargo fmt -- --emit files
   ```
 
   Options:
@@ -222,7 +187,7 @@ See [Configurations.md](Configurations.md) for details.
   | Flag |Description| Nightly Only |
   |:---:|:---:|:---:|
   | files | overwrites output to files | No |
-  | stdout | writes output to stdout | 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 |