Skip to content

Commit 2e7c2a9

Browse files
committed
docs(dev-guide): update the section on clippy lints
1 parent eca06da commit 2e7c2a9

File tree

1 file changed

+6
-19
lines changed

1 file changed

+6
-19
lines changed

doc/dev-guide/src/coding-standards.md

Lines changed: 6 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -50,21 +50,13 @@ APIs, you can refer to the documentation of the [`Assert`] type.
5050

5151
## Clippy lints
5252

53-
We do not enforce lint status in the checks done by GitHub Actions, because
54-
clippy is a moving target that can make it hard to merge for little benefit.
53+
At the time of writing, rustup's CI pipeline runs clippy on both Windows and
54+
Linux, but contributors to particularly OS-specific code should also make
55+
sure that their clippy checking is done on that particular platform, as
56+
OS-conditional code is a common source of unused imports and other small lints,
57+
which can build up over time.
5558

56-
We do ask that contributors keep the clippy status clean themselves.
57-
58-
Minimally, run `cargo clippy --all --all-targets --features test -- -D warnings` before
59-
submitting code.
60-
61-
If possible, adding `--all-features` to the command is useful, but will require
62-
additional dependencies like `libcurl-dev`.
63-
64-
Regular contributors or contributors to particularly OS-specific code should
65-
also make sure that their clippy checking is done on at least Linux and Windows,
66-
as OS-conditional code is a common source of unused imports and other small
67-
lints, which can build up over time.
59+
## Writing platform-specific code
6860

6961
For developers using BSD/Linux/Mac OS, there are Windows VM's suitable for such
7062
development tasks for use with virtualbox and other hypervisors are downloadable
@@ -73,8 +65,3 @@ from
7365
Similarly, there are many Linux and Unix operating systems images available for
7466
developers whose usual operating system is Windows. Currently Rustup has no Mac
7567
OS specific code, so there should be no need to worry about Mac VM images.
76-
77-
Clippy is also run in GitHub Actions, in the `General Checks / Checks` build
78-
task, but not currently run per-platform, which means there is no way to find
79-
out the status of clippy per platform without running it on that platform as a
80-
developer.

0 commit comments

Comments
 (0)