Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update Readme #105553

Closed
wants to merge 1 commit into from
Closed

Update Readme #105553

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
158 changes: 84 additions & 74 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
This is the main source code repository for [Rust]. It contains the compiler,
standard library, and documentation.

[Rust]: https://www.rust-lang.org
[Rust]: https://www.rust-lang.org/

**Note: this README is for _users_ rather than _contributors_.
If you wish to _contribute_ to the compiler, you should read the
[Getting Started][gettingstarted] section of the rustc-dev-guide instead.
You can ask for help in the [#new members Zulip stream][new-members].**
**Note: this README is for _users_ rather than _contributors_. If you wish to
_contribute_ to the compiler, you should read the
[Getting Started][gettingstarted] section of the rustc-dev-guide instead. You
can ask for help in the [#new members Zulip stream][new-members].**
Comment on lines +8 to +11
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Markdown doesn't need orphan line starts like this: The previous way puts each individual topic on its own lines. That way diffs affect the appropriate lines and not irrelevant content.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That isn't consistent with how other paragraphs in the Readme are formatted though. What makes these two different?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apologies for missing this question.

There's no need for excessive consistency. Alternatively, you can make them consistent in the more topic-oriented direction. Either a rule should be programmatically enforced, which I am fine with, or the formatting style should incline towards whatever is most natural, and thus will be most-preserved by subsequent edits.

I also didn't highlight all the line endings that I would not have changed this way, I merely did it to two examples to set a trend.


[new-members]: https://rust-lang.zulipchat.com/#narrow/stream/122652-new-members

Expand All @@ -32,7 +32,10 @@ The `x.py` command can be run directly on most systems in the following format:

This is how the documentation and examples assume you are running `x.py`.

Systems such as Ubuntu 20.04 LTS do not create the necessary `python` command by default when Python is installed that allows `x.py` to be run directly. In that case, you can either create a symlink for `python` (Ubuntu provides the `python-is-python3` package for this), or run `x.py` using Python itself:
Systems such as Ubuntu 20.04 LTS do not create the necessary `python` command
by default when Python is installed that allows `x.py` to be run directly. In
that case, you can either create a symlink for `python` (Ubuntu provides the
`python-is-python3` package for this), or run `x.py` using Python itself:
Comment on lines +35 to +38
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For the same reason, this should probably be broken up by sentence/fragment topic and not by a simple numeric line break.


```sh
# Python 3
Expand All @@ -42,13 +45,14 @@ python3 x.py <subcommand> [flags]
python2.7 x.py <subcommand> [flags]
```

More information about `x.py` can be found
by running it with the `--help` flag or reading the [rustc dev guide][rustcguidebuild].
More information about `x.py` can be found by running it with the `--help` flag
or reading the [rustc dev guide][rustcguidebuild].

[gettingstarted]: https://rustc-dev-guide.rust-lang.org/getting-started.html
[rustcguidebuild]: https://rustc-dev-guide.rust-lang.org/building/how-to-build-and-run.html

### Building on a Unix-like system

1. Make sure you have installed the dependencies:

* `g++` 5.1 or later or `clang++` 3.5 or later
Expand All @@ -72,31 +76,33 @@ by running it with the `--help` flag or reading the [rustc dev guide][rustcguide

3. Configure the build settings:

The Rust build system uses a file named `config.toml` in the root of the
source tree to determine various configuration settings for the build.
Copy the default `config.toml.example` to `config.toml` to get started.
The Rust build system uses a file named `config.toml` in the root of the
source tree to determine various configuration settings for the build. Copy
the default `config.toml.example` to `config.toml` to get started.
Comment on lines +80 to +81
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
source tree to determine various configuration settings for the build. Copy
the default `config.toml.example` to `config.toml` to get started.
source tree to determine various configuration settings for the build.
Copy the default `config.toml.example` to `config.toml` to get started.


```sh
cp config.toml.example config.toml
```
```sh
cp config.toml.example config.toml
```

If you plan to use `x.py install` to create an installation, it is recommended
that you set the `prefix` value in the `[install]` section to a directory.
If you plan to use `x.py install` to create an installation, it is
recommended that you set the `prefix` value in the `[install]` section to a
directory.

Create an install directory if you are not installing in the default directory.
Create an install directory if you are not installing in the default
directory.

4. Build and install:

```sh
./x.py build && ./x.py install
```
```sh
./x.py build && ./x.py install
```

When complete, `./x.py install` will place several programs into
`$PREFIX/bin`: `rustc`, the Rust compiler, and `rustdoc`, the
API-documentation tool. This install does not include [Cargo],
Rust's package manager. To build and install Cargo, you may
run `./x.py install cargo` or set the `build.extended` key in
`config.toml` to `true` to build and install all tools.
When complete, `./x.py install` will place several programs into
`$PREFIX/bin`: `rustc`, the Rust compiler, and `rustdoc`, the
API-documentation tool. This install does not include [Cargo], Rust's
package manager. To build and install Cargo, you may run
`./x.py install cargo` or set the `build.extended` key in `config.toml` to
`true` to build and install all tools.

[Cargo]: https://github.com/rust-lang/cargo

Expand All @@ -105,8 +111,9 @@ by running it with the `--help` flag or reading the [rustc dev guide][rustcguide
There are two prominent ABIs in use on Windows: the native (MSVC) ABI used by
Visual Studio and the GNU ABI used by the GCC toolchain. Which version of Rust
you need depends largely on what C/C++ libraries you want to interoperate with.
Use the MSVC build of Rust to interop with software produced by Visual Studio and
the GNU build to interop with GNU software built using the MinGW/MSYS2 toolchain.
Use the MSVC build of Rust to interop with software produced by Visual Studio
and the GNU build to interop with GNU software built using the MinGW/MSYS2
toolchain.

#### MinGW

Expand All @@ -119,20 +126,21 @@ the GNU build to interop with GNU software built using the MinGW/MSYS2 toolchain
2. Run `mingw32_shell.bat` or `mingw64_shell.bat` from the MSYS2 installation
directory (e.g. `C:\msys64`), depending on whether you want 32-bit or 64-bit
Rust. (As of the latest version of MSYS2 you have to run `msys2_shell.cmd
-mingw32` or `msys2_shell.cmd -mingw64` from the command line instead)
-mingw32` or `msys2_shell.cmd -mingw64` from the command line instead.)

3. From this terminal, install the required tools:

```sh
# Update package mirrors (may be needed if you have a fresh install of MSYS2)
# Update package mirrors (may be needed if you have a fresh install of
# MSYS2).
pacman -Sy pacman-mirrors

# Install build tools needed for Rust. If you're building a 32-bit compiler,
# then replace "x86_64" below with "i686". If you've already got git, python,
# or CMake installed and in PATH you can remove them from this list. Note
# that it is important that you do **not** use the 'python2', 'cmake' and 'ninja'
# packages from the 'msys2' subsystem. The build has historically been known
# to fail with these packages.
# then replace "x86_64" below with "i686". If you've already got Git,
# Python, or CMake installed and in PATH you can remove them from this list.
# Note that it is important that you do **not** use the 'python2', 'cmake',
Comment on lines +139 to +141
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Obviously, I think this is largely an improvement.

# and 'ninja' packages from the 'msys2' subsystem. The build has
# historically been known to fail with these packages.
Comment on lines +142 to +143
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can move "The build" to a new line. Not required.

pacman -S git \
make \
diffutils \
Expand All @@ -153,12 +161,12 @@ the GNU build to interop with GNU software built using the MinGW/MSYS2 toolchain

MSVC builds of Rust additionally require an installation of Visual Studio 2017
(or later) so `rustc` can use its linker. The simplest way is to get
[Visual Studio], check the “C++ build tools” and “Windows 10 SDK” workload.
[Visual Studio], check the "C++ build tools" and "Windows 10 SDK" workload.

[Visual Studio]: https://visualstudio.microsoft.com/downloads/

(If you're installing cmake yourself, be careful that “C++ CMake tools for
Windows” doesn't get included under “Individual components”.)
(If you're installing CMake yourself, be careful that "C++ CMake tools for
Windows" doesn't get included under "Individual components".)

With these dependencies installed, you can build the compiler in a `cmd.exe`
shell with:
Expand All @@ -167,10 +175,11 @@ shell with:
python x.py build
```

Right now, building Rust only works with some known versions of Visual Studio. If
you have a more recent version installed and the build system doesn't understand,
you may need to force rustbuild to use an older version. This can be done
by manually calling the appropriate vcvars file before running the bootstrap.
Right now, building Rust only works with some known versions of Visual Studio.
If you have a more recent version installed and the build system doesn't
Comment on lines +178 to +179
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good.

understand, you may need to force rustbuild to use an older version. This can
be done by manually calling the appropriate vcvars file before running the
Comment on lines +180 to +181
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Optionally linebreak on "This".

bootstrap.

```batch
CALL "C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC\Auxiliary\Build\vcvars64.bat"
Expand All @@ -190,9 +199,9 @@ Windows build triples are:
- `x86_64-pc-windows-msvc`

The build triple can be specified by either specifying `--build=<triple>` when
invoking `x.py` commands, or by copying the `config.toml` file (as described
in [Installing From Source](#installing-from-source)), and modifying the
`build` option under the `[build]` section.
invoking `x.py` commands, or by copying the `config.toml` file (as described in
[Installing from Source](#installing-from-source)), and modifying the `build`
option under the `[build]` section.

### Configure and Make

Expand All @@ -204,45 +213,45 @@ configure script and makefile (the latter of which just invokes `x.py`).
make && sudo make install
```

When using the configure script, the generated `config.mk` file may override the
`config.toml` file. To go back to the `config.toml` file, delete the generated
`config.mk` file.
When using the configure script, the generated `config.mk` file may override
the `config.toml` file. To go back to the `config.toml` file, delete the
generated `config.mk` file.

## Building Documentation

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

```sh
./x.py doc
```

The generated documentation will appear under `doc` in the `build` directory for
the ABI used. I.e., if the ABI was `x86_64-pc-windows-msvc`, the directory will be
`build\x86_64-pc-windows-msvc\doc`.
The generated documentation will appear under `doc` in the `build` directory
for the ABI used. I.e., if the ABI was `x86_64-pc-windows-msvc`, the directory
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awkward Latin abbreviation in the middle of nowhere, worsens readability for no good reason, doesn't have to be changed her but if you have an opinion on what else could go here I'd be happy to see it.

Suggested change
for the ABI used. I.e., if the ABI was `x86_64-pc-windows-msvc`, the directory
for the ABI used. That is, if the ABI was `x86_64-pc-windows-msvc`, the directory

will be `build\x86_64-pc-windows-msvc\doc`.

## Notes

Since the Rust compiler is written in Rust, it must be built by a
precompiled "snapshot" version of itself (made in an earlier stage of
development). As such, source builds require an Internet connection to
fetch snapshots, and an OS that can execute the available snapshot binaries.
Since the Rust compiler is written in Rust, it must be built by a precompiled
"snapshot" version of itself (made in an earlier stage of development). As
such, source builds require an Internet connection to fetch snapshots, and an
OS that can execute the available snapshot binaries.
Comment on lines +235 to +237
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Again, opportunity for topical split:

Suggested change
"snapshot" version of itself (made in an earlier stage of development). As
such, source builds require an Internet connection to fetch snapshots, and an
OS that can execute the available snapshot binaries.
"snapshot" version of itself (made in an earlier stage of development).
As such, source builds require an Internet connection to fetch snapshots,
and an OS that can execute the available snapshot binaries.


Snapshot binaries are currently built and tested on several platforms:

| Platform / Architecture | x86 | x86_64 |
|---------------------------------------------|-----|--------|
| Windows (7, 8, 10, ...) | ✓ | ✓ |
| Linux (kernel 3.2, glibc 2.17 or later) | ✓ | ✓ |
| macOS (10.7 Lion or later) | (\*) | ✓ |
| Platform / Architecture | x86 | x86_64 |
|-----------------------------------------|------|--------|
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's choose an alignment for these if we're going to fuss over them.

Suggested change
|-----------------------------------------|------|--------|
|-----------------------------------------|:----:|:------:|

| Windows (7, 8, 10, ...) | ✓ | ✓ |
| Linux (kernel 3.2, glibc 2.17 or later) | ✓ | ✓ |
| macOS (10.7 Lion or later) | (\*) | ✓ |
Comment on lines +243 to +245
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

They can remain left-justified in the source, obviously.


(\*): Apple dropped support for running 32-bit binaries starting from macOS 10.15 and iOS 11.
Due to this decision from Apple, the targets are no longer useful to our users.
Please read [our blog post][macx32] for more info.
(\*): Apple dropped support for running 32-bit binaries starting from macOS
10.15 and iOS 11. Due to this decision from Apple, the targets are no longer
useful to our users. Please read [our blog post][macx32] for more info.
Comment on lines -238 to +249
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is one of the examples of "less good". This is topic-split and now it gets line-broken and the next topic gets connected in unnecessarily.


[macx32]: https://blog.rust-lang.org/2020/01/03/reducing-support-for-32-bit-apple-targets.html

You may find that other platforms work, but these are our officially
supported build environments that are most likely to work.
You may find that other platforms work, but these are our officially supported
build environments that are most likely to work.

## Getting Help

Expand All @@ -253,35 +262,36 @@ The Rust community congregates in a few places:
* [/r/rust] - News and general discussion.

[Stack Overflow]: https://stackoverflow.com/questions/tagged/rust
[/r/rust]: https://reddit.com/r/rust
[/r/rust]: https://www.reddit.com/r/rust/
[users.rust-lang.org]: https://users.rust-lang.org/

## Contributing

If you are interested in contributing to the Rust project, please take a look
at the [Getting Started][gettingstarted] guide in the [rustc-dev-guide].

[rustc-dev-guide]: https://rustc-dev-guide.rust-lang.org
[rustc-dev-guide]: https://rustc-dev-guide.rust-lang.org/

## License

Rust is primarily distributed under the terms of both the MIT license
and the Apache License (Version 2.0), with portions covered by various
BSD-like licenses.
Rust is primarily distributed under the terms of both the MIT license and the
Apache License (Version 2.0), with portions covered by various BSD-like
licenses.

See [LICENSE-APACHE](LICENSE-APACHE), [LICENSE-MIT](LICENSE-MIT), and
[COPYRIGHT](COPYRIGHT) for details.

## Trademark

[The Rust Foundation][rust-foundation] owns and protects the Rust and Cargo
trademarks and logos (the “Rust Trademarks”).
trademarks and logos (the "Rust Trademarks").

If you want to use these names or brands, please read the [media guide][media-guide].
If you want to use these names or brands, please read the
[media guide][media-guide].

Third-party logos may be subject to third-party copyrights and trademarks. See
[Licenses][policies-licenses] for details.

[rust-foundation]: https://foundation.rust-lang.org/
[media-guide]: https://www.rust-lang.org/policies/media-guide
[media-guide]: https://foundation.rust-lang.org/policies/logo-policy-and-media-guide/
[policies-licenses]: https://www.rust-lang.org/policies/licenses