Skip to content

Commit e2e85b7

Browse files
Update notes regarding ./configure and configuration
1 parent 6c79a0e commit e2e85b7

File tree

2 files changed

+28
-7
lines changed

2 files changed

+28
-7
lines changed

CONTRIBUTING.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -119,9 +119,10 @@ configuration used in the build process. Some options to note:
119119
For more options, the `config.toml` file contains commented out defaults, with
120120
descriptions of what each option will do.
121121

122-
Note: Previously the `./configure` script was used for configuration, but
123-
is now deprecated. If you still have a `config.mk` file in your directory,
124-
you may need to delete it for `config.toml` to work.
122+
Note: Previously the `./configure` script was used to configure this
123+
project. It can still be used, but it's recommended to use a `config.toml`
124+
file. If you still have a `config.mk` file in your directory - from
125+
`./configure` - you may need to delete it for `config.toml` to work.
125126

126127
### Building
127128

@@ -189,8 +190,8 @@ To learn about all possible rules you can execute, run:
189190
python x.py build --help --verbose
190191
```
191192

192-
Note: Previously `./configure` and `make` were used to build this project,
193-
but these are now deprecated.
193+
Note: Previously `./configure` and `make` were used to build this project.
194+
They are still available, but `x.py` is the recommended build system.
194195

195196
### Useful commands
196197

README.md

+22-2
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,6 @@ Read ["Installing Rust"] from [The Book].
3636

3737
```sh
3838
$ ./x.py build && sudo ./x.py dist --install
39-
$ make && sudo make install
4039
```
4140

4241
> ***Note:*** Install locations can be adjusted by copying the config file
@@ -116,9 +115,16 @@ With these dependencies installed, you can build the compiler with:
116115
If you're running inside of an msys shell, however, you can run:
117116

118117
```sh
119-
$ ./x.py build --build=x86_64-pc-windows-msvc && ./x.py dist --install
118+
$ ./x.py build --build=x86_64-pc-windows-msvc
119+
$ ./x.py dist --build=x86_64-pc-windows-msvc --install
120120
```
121121

122+
> ***Note:*** The build option can also be configured by copying
123+
> the config file and adjusting the `build` option under `[build]`.
124+
> ```sh
125+
> $ cp ./src/bootstrap/config.toml.example ./config.toml
126+
> ```
127+
122128
Currently building Rust only works with some known versions of Visual Studio. If
123129
you have a more recent version installed the build system doesn't understand
124130
then you may need to force rustbuild to use an older version. This can be done
@@ -129,6 +135,20 @@ CALL "C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\bin\amd64\vcvars64.
129135
python x.py build
130136
```
131137

138+
### Configure and Make
139+
140+
While it's not the recommended build system, this project also provides a
141+
configure script and makefile (the latter of which just invokes `x.py`).
142+
143+
```sh
144+
$ ./configure
145+
$ make && sudo make install
146+
```
147+
148+
When using the configure script, the generated config.mk` file may override the
149+
`config.toml` file. To go back to the `config.toml` file, delete the generated
150+
`config.mk` file.
151+
132152
## Building Documentation
133153

134154
If you’d like to build the documentation, it’s almost the same:

0 commit comments

Comments
 (0)