]> git.lizzy.rs Git - rust.git/blobdiff - README.md
Merge pull request #3010 from topecongiro/issue-3009
[rust.git] / README.md
index b2cc0c12d467d70714aa8a9e1412a7b0452d2dc3..8d8bfcc1e0190745ccbaf2eee4dbeb6a2c247d13 100644 (file)
--- a/README.md
+++ b/README.md
@@ -6,25 +6,11 @@ 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).
 
-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.
 
-
 ## Quick start
 
 You can run `rustfmt` with Rust 1.24 and above.
@@ -53,7 +39,7 @@ cargo +nightly fmt
 To format code that requires edition 2018, create a `rustfmt.toml` [configuration](#configuring-rustfmt) file containing:
 
 ```toml
-edition = "Edition2018"
+edition = "2018"
 ```
 
 ## Limitations
@@ -143,8 +129,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:
@@ -171,7 +155,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
@@ -200,29 +184,6 @@ 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: