1
1
# rust-semverver
2
2
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 )
4
4
[ ![ Current Version] ( https://meritbadge.herokuapp.com/semverver )] ( https://crates.io/crates/semverver )
5
5
6
6
` rust-semverver ` is a tool to check semver-compliance in Rust library crates. The core of
7
7
the tool has been developed as a student project during the Google Summer of Code 2017.
8
8
9
9
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 ) .
11
11
12
12
## Background
13
13
@@ -17,17 +17,18 @@ said dummy and all necessary analysis is performed in that context, where type i
17
17
and other resources are available.
18
18
19
19
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 ) .
21
21
22
22
## Installation
23
23
24
24
The tool is implemented as a cargo plugin. As of now, it can be obtained from this git
25
25
repository and compiled from source or installed from
26
26
[ 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.
28
28
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.
31
32
Then you can do:
32
33
33
34
``` sh
@@ -42,8 +43,8 @@ can be added here).
42
43
You can also install the newest version of the tool from git:
43
44
44
45
``` 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
47
48
```
48
49
49
50
<details >
@@ -53,7 +54,7 @@ $ cargo +nightly-2020-11-19 install --git https://github.com/rust-dev-tools/rust
53
54
</summary >
54
55
55
56
``` sh
56
- $ git clone https://github.com/rust-dev-tools /rust-semverver
57
+ $ git clone https://github.com/rust-lang /rust-semverver
57
58
$ cd rust-semverver
58
59
$ cargo install
59
60
```
@@ -88,7 +89,7 @@ Options:
88
89
-h, --help print this message and exit
89
90
-V, --version print version information and exit
90
91
-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
92
93
messages
93
94
--show-public print the public types in the current crate given by
94
95
-c or -C and exit
@@ -248,7 +249,7 @@ correctly:
248
249
* changes from tuple structs or variants to struct variants and vice-versa
249
250
* changes to a function or method's constness
250
251
* 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
252
253
* correct handling of "sealed" traits
253
254
* changes to the unsafety of a trait
254
255
* type changes of all toplevel items, as well as associated items in inherent impls and
@@ -262,7 +263,7 @@ the required versioning policy.
262
263
## Contributing
263
264
264
265
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 ) .
266
267
267
268
## License
268
269
0 commit comments