X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=README.md;h=00bb501941dd76c5845cd04476c405801855d7fe;hb=12c03db157ced04b5436288781ae0a1728d78e02;hp=9d5939db8d5d1d72a2668b89d294d0607e93cd44;hpb=6ce05bf849a86dc8c0d7756d679f442e979b5eaf;p=rust.git diff --git a/README.md b/README.md index 9d5939db8d5..00bb501941d 100644 --- a/README.md +++ b/README.md @@ -1,193 +1,283 @@ -# Clippy +# The Rust Programming Language -[![Clippy Test](https://github.com/rust-lang/rust-clippy/workflows/Clippy%20Test/badge.svg?branch=auto&event=push)](https://github.com/rust-lang/rust-clippy/actions?query=workflow%3A%22Clippy+Test%22+event%3Apush+branch%3Aauto) -[![License: MIT OR Apache-2.0](https://img.shields.io/crates/l/clippy.svg)](#license) +This is the main source code repository for [Rust]. It contains the compiler, +standard library, and documentation. -A collection of lints to catch common mistakes and improve your [Rust](https://github.com/rust-lang/rust) code. +[Rust]: https://www.rust-lang.org -[There are 362 lints included in this crate!](https://rust-lang.github.io/rust-clippy/master/index.html) +## Quick Start -We have a bunch of lint categories to allow you to choose how much Clippy is supposed to ~~annoy~~ help you: +Read ["Installation"] from [The Book]. -* `clippy::all` (everything that is on by default: all the categories below except for `nursery`, `pedantic`, and `cargo`) -* `clippy::correctness` (code that is just **outright wrong** or **very very useless**, causes hard errors by default) -* `clippy::style` (code that should be written in a more idiomatic way) -* `clippy::complexity` (code that does something simple but in a complex way) -* `clippy::perf` (code that can be written in a faster way) -* `clippy::pedantic` (lints which are rather strict, off by default) -* `clippy::nursery` (new lints that aren't quite ready yet, off by default) -* `clippy::cargo` (checks against the cargo manifest, off by default) +["Installation"]: https://doc.rust-lang.org/book/ch01-01-installation.html +[The Book]: https://doc.rust-lang.org/book/index.html -More to come, please [file an issue](https://github.com/rust-lang/rust-clippy/issues) if you have ideas! +## Installing from Source -Only the following of those categories are enabled by default: +_Note: If you wish to contribute to the compiler, you should read [this +chapter][rustcguidebuild] of the rustc-dev-guide instead of this section._ -* `clippy::style` -* `clippy::correctness` -* `clippy::complexity` -* `clippy::perf` +The Rust build system has a Python script called `x.py` to bootstrap building +the compiler. More information about it may be found by running `./x.py --help` +or reading the [rustc dev guide][rustcguidebuild]. -Other categories need to be enabled in order for their lints to be executed. +[rustcguidebuild]: https://rustc-dev-guide.rust-lang.org/building/how-to-build-and-run.html -The [lint list](https://rust-lang.github.io/rust-clippy/master/index.html) also contains "restriction lints", which are -for things which are usually not considered "bad", but may be useful to turn on in specific cases. These should be used -very selectively, if at all. +### Building on *nix +1. Make sure you have installed the dependencies: -Table of contents: + * `g++` 5.1 or later or `clang++` 3.5 or later + * `python` 3 or 2.7 + * GNU `make` 3.81 or later + * `cmake` 3.4.3 or later + * `curl` + * `git` + * `ssl` which comes in `libssl-dev` or `openssl-devel` + * `pkg-config` if you are compiling on Linux and targeting Linux -* [Usage instructions](#usage) -* [Configuration](#configuration) -* [Contributing](#contributing) -* [License](#license) +2. Clone the [source] with `git`: -## Usage + ```sh + $ git clone https://github.com/rust-lang/rust.git + $ cd rust + ``` -Since this is a tool for helping the developer of a library or application -write better code, it is recommended not to include Clippy as a hard dependency. -Options include using it as an optional dependency, as a cargo subcommand, or -as an included feature during build. These options are detailed below. +[source]: https://github.com/rust-lang/rust -### As a cargo subcommand (`cargo clippy`) +3. Configure the build settings: -One way to use Clippy is by installing Clippy through rustup as a cargo -subcommand. + 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. -#### Step 1: Install rustup + ```sh + $ cp config.toml.example config.toml + ``` -You can install [rustup](https://rustup.rs/) on supported platforms. This will help -us install Clippy and its dependencies. + It is recommended that if you plan to use the Rust build system to create + an installation (using `./x.py install`) that you set the `prefix` value + in the `[install]` section to a directory that you have write permissions. -If you already have rustup installed, update to ensure you have the latest -rustup and compiler: + Create install directory if you are not installing in default directory -```terminal -rustup update -``` +4. Build and install: -#### Step 2: Install Clippy + ```sh + $ ./x.py build && ./x.py install + ``` -Once you have rustup and the latest stable release (at least Rust 1.29) installed, run the following command: + 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. -```terminal -rustup component add clippy -``` -If it says that it can't find the `clippy` component, please run `rustup self update`. +[Cargo]: https://github.com/rust-lang/cargo -#### Step 3: Run Clippy +### Building on Windows -Now you can run Clippy by invoking the following command: +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: +for interop with software produced by Visual Studio use the MSVC build of Rust; +for interop with GNU software built using the MinGW/MSYS2 toolchain use the GNU +build. -```terminal -cargo clippy -``` +#### MinGW -#### Automatically applying Clippy suggestions +[MSYS2][msys2] can be used to easily build Rust on Windows: -Clippy can automatically apply some lint suggestions. -Note that this is still experimental and only supported on the nightly channel: +[msys2]: https://msys2.github.io/ -```terminal -cargo clippy --fix -Z unstable-options -``` +1. Grab the latest [MSYS2 installer][msys2] and go through the installer. + +2. Run `mingw32_shell.bat` or `mingw64_shell.bat` from wherever you installed + MSYS2 (i.e. `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) + +3. From this terminal, install the required tools: + + ```sh + # 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' and 'cmake' + # packages from the 'msys2' subsystem. The build has historically been known + # to fail with these packages. + $ pacman -S git \ + make \ + diffutils \ + tar \ + mingw-w64-x86_64-python \ + mingw-w64-x86_64-cmake \ + mingw-w64-x86_64-gcc + ``` -### Running Clippy from the command line without installing it +4. Navigate to Rust's source code (or clone it), then build it: -To have cargo compile your crate with Clippy without Clippy installation -in your code, you can use: + ```sh + $ ./x.py build && ./x.py install + ``` -```terminal -cargo run --bin cargo-clippy --manifest-path=path_to_clippys_Cargo.toml +#### MSVC + +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 the +[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”.) + +With these dependencies installed, you can build the compiler in a `cmd.exe` +shell with: + +```sh +> python x.py build ``` -*Note:* Be sure that Clippy was compiled with the same version of rustc that cargo invokes here! - -### Travis CI - -You can add Clippy to Travis CI in the same way you use it locally: - -```yml -language: rust -rust: - - stable - - beta -before_script: - - rustup component add clippy -script: - - cargo clippy - # if you want the build job to fail when encountering warnings, use - - cargo clippy -- -D warnings - # in order to also check tests and non-default crate features, use - - cargo clippy --all-targets --all-features -- -D warnings - - cargo test - # etc. +Currently, building Rust only works with some known versions of Visual Studio. If +you have a more recent version installed the build system doesn't understand +then 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. + +```batch +> CALL "C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC\Auxiliary\Build\vcvars64.bat" +> python x.py build ``` -If you are on nightly, It might happen that Clippy is not available for a certain nightly release. -In this case you can try to conditionally install Clippy from the Git repo. +### Building rustc with older host toolchains +It is still possible to build Rust with the older toolchain versions listed below, but only if the +LLVM_TEMPORARILY_ALLOW_OLD_TOOLCHAIN option is set to true in the config.toml file. + +* Clang 3.1 +* Apple Clang 3.1 +* GCC 4.8 +* Visual Studio 2015 (Update 3) + +Toolchain versions older than what is listed above cannot be used to build rustc. -```yaml -language: rust -rust: - - nightly -before_script: - - rustup component add clippy --toolchain=nightly || cargo install --git https://github.com/rust-lang/rust-clippy/ --force clippy - # etc. +#### Specifying an ABI + +Each specific ABI can also be used from either environment (for example, using +the GNU ABI in PowerShell) by using an explicit build triple. The available +Windows build triples are: +- GNU ABI (using GCC) + - `i686-pc-windows-gnu` + - `x86_64-pc-windows-gnu` +- The MSVC ABI + - `i686-pc-windows-msvc` + - `x86_64-pc-windows-msvc` + +The build triple can be specified by either specifying `--build=` 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. + +### Configure and Make + +While it's not the recommended build system, this project also provides a +configure script and makefile (the latter of which just invokes `x.py`). + +```sh +$ ./configure +$ make && sudo make install ``` -Note that adding `-D warnings` will cause your build to fail if **any** warnings are found in your code. -That includes warnings found by rustc (e.g. `dead_code`, etc.). If you want to avoid this and only cause -an error for Clippy warnings, use `#![deny(clippy::all)]` in your code or `-D clippy::all` on the command -line. (You can swap `clippy::all` with the specific lint category you are targeting.) +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. -## Configuration +## Building Documentation -Some lints can be configured in a TOML file named `clippy.toml` or `.clippy.toml`. It contains a basic `variable = -value` mapping eg. +If you’d like to build the documentation, it’s almost the same: -```toml -blacklisted-names = ["toto", "tata", "titi"] -cognitive-complexity-threshold = 30 +```sh +$ ./x.py doc ``` -See the [list of lints](https://rust-lang.github.io/rust-clippy/master/index.html) for more information about which -lints can be configured and the meaning of the variables. +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`. + +## Notes -To deactivate the “for further information visit *lint-link*” message you can -define the `CLIPPY_DISABLE_DOCS_LINKS` environment variable. +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 a connection to the Internet, to +fetch snapshots, and an OS that can execute the available snapshot binaries. -### Allowing/denying lints +Snapshot binaries are currently built and tested on several platforms: -You can add options to your code to `allow`/`warn`/`deny` Clippy lints: +| Platform / Architecture | x86 | x86_64 | +|----------------------------|-----|--------| +| Windows (7, 8, 10, ...) | ✓ | ✓ | +| Linux (2.6.18 or later) | ✓ | ✓ | +| macOS (10.7 Lion or later) | ✓ | ✓ | -* the whole set of `Warn` lints using the `clippy` lint group (`#![deny(clippy::all)]`) +You may find that other platforms work, but these are our officially +supported build environments that are most likely to work. -* all lints using both the `clippy` and `clippy::pedantic` lint groups (`#![deny(clippy::all)]`, - `#![deny(clippy::pedantic)]`). Note that `clippy::pedantic` contains some very aggressive - lints prone to false positives. +There is more advice about hacking on Rust in [CONTRIBUTING.md]. -* only some lints (`#![deny(clippy::single_match, clippy::box_vec)]`, etc.) +[CONTRIBUTING.md]: https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md -* `allow`/`warn`/`deny` can be limited to a single function or module using `#[allow(...)]`, etc. +## Getting Help -Note: `deny` produces errors instead of warnings. +The Rust community congregates in a few places: -If you do not want to include your lint levels in your code, you can globally enable/disable lints by passing extra -flags to Clippy during the run: `cargo clippy -- -A clippy::lint_name` will run Clippy with `lint_name` disabled and -`cargo clippy -- -W clippy::lint_name` will run it with that enabled. This also works with lint groups. For example you -can run Clippy with warnings for all lints enabled: `cargo clippy -- -W clippy::pedantic` -If you care only about a single lint, you can allow all others and then explicitly reenable -the lint(s) you are interested in: `cargo clippy -- -Aclippy::all -Wclippy::useless_format -Wclippy::...` +* [Stack Overflow] - Direct questions about using the language. +* [users.rust-lang.org] - General discussion and broader questions. +* [/r/rust] - News and general discussion. + +[Stack Overflow]: https://stackoverflow.com/questions/tagged/rust +[/r/rust]: https://reddit.com/r/rust +[users.rust-lang.org]: https://users.rust-lang.org/ ## Contributing -If you want to contribute to Clippy, you can find more information in [CONTRIBUTING.md](https://github.com/rust-lang/rust-clippy/blob/master/CONTRIBUTING.md). +To contribute to Rust, please see [CONTRIBUTING](CONTRIBUTING.md). + +Most real-time collaboration happens in a variety of channels on the +[Rust Discord server][rust-discord], with channels dedicated for getting help, +community, documentation, and all major contribution areas in the Rust ecosystem. +A good place to ask for help would be the #help channel. + +The [rustc dev guide] might be a good place to start if you want to find out how +various parts of the compiler work. + +Also, you may find the [rustdocs for the compiler itself][rustdocs] useful. + +[rust-discord]: https://discord.gg/rust-lang +[rustc dev guide]: https://rustc-dev-guide.rust-lang.org/about-this-guide.html +[rustdocs]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_middle/ ## License -Copyright 2014-2020 The Rust Project Developers +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 programming language is an open source, community project governed +by a core team. It is also sponsored by the Mozilla Foundation (“Mozilla”), +which owns and protects the Rust and Cargo trademarks and logos +(the “Rust Trademarks”). + +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. -Licensed under the Apache License, Version 2.0 or the MIT license -, at your -option. Files in the project may not be -copied, modified, or distributed except according to those terms. +[media-guide]: https://www.rust-lang.org/policies/media-guide +[policies-licenses]: https://www.rust-lang.org/policies/licenses