Skip to content
This repository was archived by the owner on Apr 5, 2024. It is now read-only.

Commit 3947ad8

Browse files
committed
Auto merge of #174 - JohnTitor:docs-cleanup, r=JohnTitor
Clean-up docs Follow-up to #173. - Replace `rust-dev-tools` with `rust-lang` - Add some comments to sync with nightly date between rust-toolchain and README
2 parents 99f39a1 + 7cd4231 commit 3947ad8

File tree

3 files changed

+15
-13
lines changed

3 files changed

+15
-13
lines changed

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[package]
22
name = "semverver"
33
description = "Automatic verification of SemVer adherence in Rust library crates"
4-
repository = "https://github.com/rust-dev-tools/rust-semverver"
4+
repository = "https://github.com/rust-lang/rust-semverver"
55
readme = "README.md"
66
keywords = ["semver", "plugin"]
77
categories = ["development-tools", "development-tools::cargo-plugins"]

README.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# rust-semverver
22

3-
[![Build Status](https://github.com/rust-dev-tools/rust-semverver/workflows/CI/badge.svg?branch=master)](https://github.com/rust-dev-tools/rust-semverver/actions?query=workflow%3ACI+branch%3Amaster)
3+
[![Build Status](https://github.com/rust-lang/rust-semverver/workflows/CI/badge.svg?branch=master)](https://github.com/rust-lang/rust-semverver/actions?query=workflow%3ACI+branch%3Amaster)
44
[![Current Version](https://meritbadge.herokuapp.com/semverver)](https://crates.io/crates/semverver)
55

66
`rust-semverver` is a tool to check semver-compliance in Rust library crates. The core of
77
the tool has been developed as a student project during the Google Summer of Code 2017.
88

99
Details on the work done during GSoC 2017 can be found
10-
[here](https://github.com/rust-dev-tools/rust-semverver/blob/master/doc/gsoc.md).
10+
[here](https://github.com/rust-lang/rust-semverver/blob/master/doc/gsoc.md).
1111

1212
## Background
1313

@@ -17,17 +17,18 @@ said dummy and all necessary analysis is performed in that context, where type i
1717
and other resources are available.
1818

1919
More information on the inner workings of the tool can be found
20-
[here](https://github.com/rust-dev-tools/rust-semverver/blob/master/doc/impl_notes.md).
20+
[here](https://github.com/rust-lang/rust-semverver/blob/master/doc/impl_notes.md).
2121

2222
## Installation
2323

2424
The tool is implemented as a cargo plugin. As of now, it can be obtained from this git
2525
repository and compiled from source or installed from
2626
[crates.io](https://crates.io/crates/semverver). Keep in mind that only the pinned version(in [rust-toolchain])
27-
of the nighly toolchain is supported at any given time.
27+
of the nightly toolchain is supported at any given time.
2828

29-
30-
It's recommended to use Rust nightly-2020-11-19. You can install it by using `rustup install nightly-2020-11-19` if you already have rustup.
29+
<!-- NOTE: Keep in sync with nightly date on rust-toolchain. -->
30+
It's recommended to use `nightly-2020-11-19` toolchain.
31+
You can install it by using `rustup install nightly-2020-11-19` if you already have rustup.
3132
Then you can do:
3233

3334
```sh
@@ -42,8 +43,8 @@ can be added here).
4243
You can also install the newest version of the tool from git:
4344

4445
```sh
45-
$ rustup component add rustc-dev llvm-tools-preview --toolchain nightly
46-
$ cargo +nightly-2020-11-19 install --git https://github.com/rust-dev-tools/rust-semverver
46+
$ rustup component add rustc-dev llvm-tools-preview --toolchain nightly-2020-11-19
47+
$ cargo +nightly-2020-11-19 install --git https://github.com/rust-lang/rust-semverver
4748
```
4849

4950
<details>
@@ -53,7 +54,7 @@ $ cargo +nightly-2020-11-19 install --git https://github.com/rust-dev-tools/rust
5354
</summary>
5455

5556
```sh
56-
$ git clone https://github.com/rust-dev-tools/rust-semverver
57+
$ git clone https://github.com/rust-lang/rust-semverver
5758
$ cd rust-semverver
5859
$ cargo install
5960
```
@@ -88,7 +89,7 @@ Options:
8889
-h, --help print this message and exit
8990
-V, --version print version information and exit
9091
-e, --explain print detailed error explanations
91-
-q, --quiet surpress regular cargo output, print only important
92+
-q, --quiet suppress regular cargo output, print only important
9293
messages
9394
--show-public print the public types in the current crate given by
9495
-c or -C and exit
@@ -248,7 +249,7 @@ correctly:
248249
* changes from tuple structs or variants to struct variants and vice-versa
249250
* changes to a function or method's constness
250251
* additions and removals of a self-parameter on methods
251-
* additions and removals of (posslibly defaulted) trait items
252+
* additions and removals of (possibly defaulted) trait items
252253
* correct handling of "sealed" traits
253254
* changes to the unsafety of a trait
254255
* type changes of all toplevel items, as well as associated items in inherent impls and
@@ -262,7 +263,7 @@ the required versioning policy.
262263
## Contributing
263264

264265
Please see
265-
[CONTRIBUTING.md](https://github.com/rust-dev-tools/rust-semverver/blob/master/CONTRIBUTING.md).
266+
[CONTRIBUTING.md](https://github.com/rust-lang/rust-semverver/blob/master/CONTRIBUTING.md).
266267

267268
## License
268269

rust-toolchain

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
# NOTE: Keep in sync with nightly date on README
12
[toolchain]
23
channel = "nightly-2020-11-19"
34
components = ["llvm-tools-preview", "rustc-dev"]

0 commit comments

Comments
 (0)