Skip to content

Commit aa4c112

Browse files
committed
update docs and config to stop using nightly for rustfmt
1 parent e5069cf commit aa4c112

File tree

3 files changed

+5
-36
lines changed

3 files changed

+5
-36
lines changed

.github/workflows/rust.yml

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,12 @@ jobs:
1414
runs-on: ubuntu-18.04
1515
steps:
1616
- uses: actions/checkout@230611dbd0eb52da1e1f4f7bc8bb0c3a339fc8b7
17-
- uses: actions-rs/toolchain@88dc2356392166efad76775c878094f4e83ff746
18-
with:
19-
toolchain: nightly-2021-03-25
20-
default: false
21-
components: rustfmt
2217
- name: Report cargo version
23-
run: cargo +nightly-2021-03-25 --version
18+
run: cargo --version
2419
- name: Report rustfmt version
25-
run: cargo +nightly-2021-03-25 fmt -- --version
20+
run: cargo fmt -- --version
2621
- name: Check style
27-
run: cargo +nightly-2021-03-25 fmt -- --check
22+
run: cargo fmt -- --check
2823

2924
clippy-lint:
3025
runs-on: ubuntu-18.04

.vscode/settings.json

Lines changed: 0 additions & 8 deletions
This file was deleted.

README.adoc

Lines changed: 2 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -15,34 +15,16 @@ You can build the documentation yourself with:
1515
$ cargo +nightly doc
1616
----
1717

18-
1918
== Contributing
2019

21-
For maintainers (e.g., publishing new releases and managing dependabot), see link:./MAINTAINERS.adoc[MAINTAINERS.adoc].
22-
23-
=== Building and testing
24-
2520
You can **build and run the whole test suite** with `cargo test`. The test
2621
suite runs cleanly and should remain clean.
2722

28-
=== Code formatting and lint
29-
30-
Dropshot works with stable Rust versions, but for consistency the code is
31-
_formatted_ with a specific version of `rustfmt`. To contribute to Dropshot,
32-
you will need to have installed the `nightly-2021-03-25` version of the Rust
33-
toolchain:
34-
35-
----
36-
$ rustup install nightly-2021-03-25
37-
----
38-
39-
You can then **format the code** using `cargo +nightly-2021-03-25 fmt` or
40-
`rustfmt +nightly-2021-03-25`. Make sure to run this before pushing changes.
41-
The CI uses this version of `rustfmt` to check that the code is correctly
42-
formatted.
23+
You can format the code using `cargo fmt`. CI checks that code is correctly formatted.
4324

4425
https://github.com/rust-lang/rust-clippy[Clippy] is used to check for common code issues. (We disable the style checks.) You can run it with `cargo clippy`. CI will run clippy as well.
4526

27+
For maintainers (e.g., publishing new releases and managing dependabot), see link:./MAINTAINERS.adoc[MAINTAINERS.adoc].
4628

4729
== Configuration reference
4830

0 commit comments

Comments
 (0)