Auto merge of #29695 - dtrebbien:remove-mention-of-struct_variant-feature, r=sanxiyn

[rust.git] / README.md

diff --git a/README.md b/README.md
index c4a3becacb42f81c5463b818cff4ccb6fa9142e9..5e208a76e0315eece69a710b50b6daa94758f1cf 100644 (file)
--- a/README.md
+++ b/README.md
@@ -68,10 +68,14 @@ Read ["Installing Rust"] from [The Book].
    # Update package mirrors (may be needed if you have a fresh install of MSYS2)
    $ pacman -Sy pacman-mirrors
 
-   # Choose one based on platform:
+   # Choose one based on platform: 
+   # *** see the note below ***
    $ pacman -S mingw-w64-i686-toolchain
    $ pacman -S mingw-w64-x86_64-toolchain
 
+   # Make git available in MSYS2 (if not already available on path)
+   $ pacman -S git
+
    $ pacman -S base-devel
    ```
 
@@ -84,6 +88,16 @@ Read ["Installing Rust"] from [The Book].
    $ ./configure
    $ make && make install
    ```
+> ***Note:*** gcc versions >= 5 currently have issues building LLVM on Windows
+> resulting in a segmentation fault when building Rust. In order to avoid this
+> it may be necessary to obtain an earlier version of gcc such as 4.9.x.  
+> Msys's `pacman` will install the latest version, so for the time being it is
+> recommended to skip gcc toolchain installation step above and use [Mingw-Builds]
+> project's installer instead.  Be sure to add gcc `bin` directory to the path
+> before running `configure`.  
+> For more information on this see issue #28260.
+
+[Mingw-Builds]: http://sourceforge.net/projects/mingw-w64/
 
 ## Building Documentation
 
@@ -98,7 +112,7 @@ Building the documentation requires building the compiler, so the above
 details will apply. Once you have the compiler built, you can
 
 ```sh
-$ make docs NO_REBUILD=1 
+$ make docs NO_REBUILD=1
 ```
 
 To make sure you don’t re-build the compiler because you made a change