Replace ./configure with config.toml in README.md and CONTRIBUTING.md #40056

keeperofdakeys · 2017-02-23T11:20:12Z

Replace ./configure with config.toml in README.md and CONTRIBUTING.md, so that new users aren't confused about which build system to use, and how to configure the build process.

rust-highfive · 2017-02-23T11:20:24Z

r? @alexcrichton

(rust_highfive has picked a reviewer for you, use r? to override)

petrochenkov · 2017-02-23T12:09:20Z

README.md

-If you're running inside of an msys shell, however, you can run:
-
-```sh
-$ ./configure --build=x86_64-pc-windows-msvc


Specifying x86_64-pc-windows-msvc is necessary, otherwise x86_64-pc-windows-gnu will be built.

petrochenkov · 2017-02-23T12:10:44Z

README.md

@@ -18,7 +18,6 @@ Read ["Installing Rust"] from [The Book].

   * `g++` 4.7 or later or `clang++` 3.x
   * `python` 2.7 (but not 3.x)
-   * GNU `make` 3.81 or later


make is required for running test suite (run-make tests)

petrochenkov · 2017-02-23T12:17:08Z

CONTRIBUTING.md

-./configure
-```
+To change configuration, you must copy the file `src/bootstrap/config.toml.example`
+to `config.toml` in the project root, and change the settings provided.


config.toml should be in the build directory, not in the project root.

Do you mean ./build/config.toml when you say this? Or "directory from which you will be running the build", as the config.toml.example file states?

directory from which you will be running the build

alexcrichton · 2017-02-23T15:32:46Z

CONTRIBUTING.md


-To see a full list of options, run `./configure --help`.
+#### `[rust]`:
+- `debuginfo = true` - Build a debug version of the compiler


Perhaps this could say "Build a compiler with debuginfo" b/c this doesn't disable optimizations or enable debug assertions

alexcrichton · 2017-02-23T15:33:37Z

CONTRIBUTING.md

@@ -185,6 +189,9 @@ To learn about all possible rules you can execute, run:
 python x.py build --help --verbose
 ```

+Note: Previously `./configure` and `make` were used to build this project,
+but these are now deprecated.


"Deprecated" is a little strong here I think because we don't plan on ever removing them. Moreso we just recommend "x.py" for a better build experience nowadays.

alexcrichton · 2017-02-23T15:34:01Z

README.md

@@ -35,15 +35,16 @@ Read ["Installing Rust"] from [The Book].
 3. Build and install:

    ```sh
-    $ ./configure
+    $ ./x.py build && sudo ./x.py dist --install
    $ make && sudo make install


This line can be deleted I believe?

alexcrichton · 2017-02-23T15:35:09Z

README.md

@@ -117,8 +116,7 @@ shell with:
 If you're running inside of an msys shell, however, you can run:

 ```sh
-$ ./configure --build=x86_64-pc-windows-msvc
-$ make && make install
+$ ./x.py build --build=x86_64-pc-windows-msvc && ./x.py dist --install


I think this may not work because the second command doesn't have --build. Perhaps this could just recommend changing the rust.build value in config.toml?

alexcrichton · 2017-02-23T15:35:32Z

Looks great, thanks! Could we perhaps still mention in the README that for those who prefer the ./configure + make system still exists?

est31 · 2017-02-23T16:48:34Z

Nice, this will fix #39739

retep998 · 2017-02-24T03:48:22Z

README.md

-$ ./configure --build=x86_64-pc-windows-msvc
-$ make && make install
+$ ./x.py build --build=x86_64-pc-windows-msvc
+$ ./x.py dist --build=x86_64-pc-windows-msvc --install


This seems wrong. Maybe we should just get rid of this msys section? It is no longer relevant.

Why is it no longer relevant? MSYS2 is still the best environment to work with both GNU and MSVC flavors.
_{^{Because PowerShell is goddamn horrible.}}

Is this a configuration that is recommended for new users on Windows? If not, it's probably fine removing it. (I don't do any dev on Windows, so I don't know the way to go here).

It doesn't really matter whether Msys2 is a good choice or not. The fact is that with rustbuild the commands are identical no matter what shell you're in (aside from python x.py vs ./x.py), so there's really no point in covering msys2 anymore. There was a point when this section mentioned you could use configure and make in msys2, but since it uses direct rustbuild now it provides no useful information.

Should it just mention --build=x86_64-pc-windopws-msvc then?

@retep998

commands are identical no matter what shell you're in

Default build triples are different.
That's why you need to explicitly specify x86_64-pc-windopws-msvc in msys/mingw and x86_64-pc-windopws-gnu in powershell/cmd.
This is probably the only notable difference in commandlines, but it needs to be mentioned.
--build=x86_64-pc-windopws-msvc looks like a correct invocation, but I'm not sure (I use config.toml).

@keeperofdakeys Kinda funny that the only section on msys2 simply tells you to target msvc, despite rustbuild defaulting to gnu if it detects an msys environment. Maybe we could replace this section with a thing that describes this default target behavior based on whether you're in an msys environment (really whether you have uname in your path), and how you can use config.toml to override the default.

retep998 · 2017-02-26T13:28:14Z

README.md

+the GNU ABI in powershell) by using an explicit build triple. The available
+Windows build triples are:
+- `x86_64-pc-windows-gnu` - The GNU ABI (using GCC)
+- `x86_64-pc-windows-msvc` - The MSVC ABI


What about i686? I mean granted nobody should be using i686 but there are people that might want it.

alexcrichton · 2017-02-27T19:45:11Z

@bors: r+

Thanks @keeperofdakeys!

bors · 2017-02-27T19:45:13Z

📌 Commit 2c695d7 has been approved by alexcrichton

…crichton Replace ./configure with config.toml in README.md and CONTRIBUTING.md Replace ./configure with config.toml in README.md and CONTRIBUTING.md, so that new users aren't confused about which build system to use, and how to configure the build process.

ishitatsuyuki · 2017-02-28T08:40:09Z

Small note: this should be rollup.

eddyb · 2017-02-28T10:13:01Z

@bors rollup

keeperofdakeys · 2017-02-28T11:11:23Z

Just squashing the commits.

eddyb · 2017-02-28T11:14:03Z

@keeperofdakeys In the future, please do so before pushing (unless the commits are quite large).
Because now I have to redo #40143 😆 (please don't force push again).

eddyb · 2017-02-28T11:15:10Z

@bors r=alexcrichton

ishitatsuyuki · 2017-02-28T11:15:10Z

There's no need of squashing, really. Just keep what you do as a concrete history.

bors · 2017-02-28T11:15:11Z

📌 Commit fb2d763 has been approved by alexcrichton

…crichton Replace ./configure with config.toml in README.md and CONTRIBUTING.md Replace ./configure with config.toml in README.md and CONTRIBUTING.md, so that new users aren't confused about which build system to use, and how to configure the build process.

keeperofdakeys · 2017-02-28T11:18:34Z

Whoops, sorry about that. I didn't realise a rollup had happened. I'll try not to do that in the future.

…crichton Replace ./configure with config.toml in README.md and CONTRIBUTING.md Replace ./configure with config.toml in README.md and CONTRIBUTING.md, so that new users aren't confused about which build system to use, and how to configure the build process.

Rollup of 9 pull requests - Successful merges: #39977, #40033, #40047, #40056, #40057, #40122, #40124, #40126, #40131 - Failed merges: #40101

rust-highfive assigned alexcrichton Feb 23, 2017

petrochenkov reviewed Feb 23, 2017

View reviewed changes

alexcrichton reviewed Feb 23, 2017

View reviewed changes

retep998 reviewed Feb 24, 2017

View reviewed changes

keeperofdakeys force-pushed the contributing branch from 19ec338 to bf878c8 Compare February 26, 2017 13:26

retep998 reviewed Feb 26, 2017

View reviewed changes

frewsxcv mentioned this pull request Feb 28, 2017

Rollup of 8 pull requests #40138

Closed

eddyb mentioned this pull request Feb 28, 2017

Rollup of 11 pull requests #40143

Closed

Replace ./configure with config.toml in README.md and CONTRIBUTING.md

fb2d763

keeperofdakeys force-pushed the contributing branch from 2c695d7 to fb2d763 Compare February 28, 2017 11:11

eddyb mentioned this pull request Feb 28, 2017

Rollup of 11 pull requests #40147

Closed

frewsxcv mentioned this pull request Feb 28, 2017

Rollup of 9 pull requests #40148

Merged

bors added a commit that referenced this pull request Feb 28, 2017

Auto merge of #40148 - frewsxcv:rollup, r=frewsxcv

be76056

Rollup of 9 pull requests - Successful merges: #39977, #40033, #40047, #40056, #40057, #40122, #40124, #40126, #40131 - Failed merges: #40101

bors merged commit fb2d763 into rust-lang:master Feb 28, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Replace ./configure with config.toml in README.md and CONTRIBUTING.md #40056

Replace ./configure with config.toml in README.md and CONTRIBUTING.md #40056

keeperofdakeys commented Feb 23, 2017

rust-highfive commented Feb 23, 2017

petrochenkov Feb 23, 2017

petrochenkov Feb 23, 2017

petrochenkov Feb 23, 2017

keeperofdakeys Feb 23, 2017

petrochenkov Feb 23, 2017

alexcrichton Feb 23, 2017

alexcrichton Feb 23, 2017

alexcrichton Feb 23, 2017

alexcrichton Feb 23, 2017

alexcrichton commented Feb 23, 2017

est31 commented Feb 23, 2017

retep998 Feb 24, 2017

petrochenkov Feb 24, 2017

keeperofdakeys Feb 24, 2017

retep998 Feb 24, 2017

keeperofdakeys Feb 24, 2017

petrochenkov Feb 24, 2017

retep998 Feb 24, 2017

retep998 Feb 26, 2017

alexcrichton commented Feb 27, 2017

bors commented Feb 27, 2017

ishitatsuyuki commented Feb 28, 2017

eddyb commented Feb 28, 2017

keeperofdakeys commented Feb 28, 2017

eddyb commented Feb 28, 2017

eddyb commented Feb 28, 2017

ishitatsuyuki commented Feb 28, 2017

bors commented Feb 28, 2017

keeperofdakeys commented Feb 28, 2017

Replace ./configure with config.toml in README.md and CONTRIBUTING.md #40056

Replace ./configure with config.toml in README.md and CONTRIBUTING.md #40056

Conversation

keeperofdakeys commented Feb 23, 2017

rust-highfive commented Feb 23, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alexcrichton commented Feb 23, 2017

est31 commented Feb 23, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alexcrichton commented Feb 27, 2017

bors commented Feb 27, 2017

ishitatsuyuki commented Feb 28, 2017

eddyb commented Feb 28, 2017

keeperofdakeys commented Feb 28, 2017

eddyb commented Feb 28, 2017

eddyb commented Feb 28, 2017

ishitatsuyuki commented Feb 28, 2017

bors commented Feb 28, 2017

keeperofdakeys commented Feb 28, 2017