@@ -27,13 +27,14 @@ repository and compiled from source or installed from
27
27
of the nightly toolchain is supported at any given time.
28
28
29
29
<!-- NOTE: Keep in sync with nightly date on rust-toolchain. -->
30
- It's recommended to use ` nightly-2021-05-21 ` toolchain.
31
- You can install it by using ` rustup install nightly-2021-05-21 ` if you already have rustup.
30
+
31
+ It's recommended to use ` nightly-2021-06-14 ` toolchain.
32
+ You can install it by using ` rustup install nightly-2021-06-14 ` if you already have rustup.
32
33
Then you can do:
33
34
34
35
``` sh
35
- $ rustup component add rustc-dev llvm-tools-preview --toolchain nightly-2021-05-21
36
- $ cargo +nightly-2021-05-21 install --git https://github.com/rust-lang/rust-semverver
36
+ $ rustup component add rustc-dev llvm-tools-preview --toolchain nightly-2021-06-14
37
+ $ cargo +nightly-2021-06-14 install --git https://github.com/rust-lang/rust-semverver
37
38
```
38
39
39
40
You'd also need ` cmake ` for some dependencies, and a few common libraries (if you hit
@@ -149,10 +150,10 @@ describing changes between the crate versions, which contains two arrays in the
149
150
The ` path_changes ` array contains objects describing item additions and removals, which
150
151
have the following keys:
151
152
152
- * ` name ` : The name of the item.
153
- * ` def_span ` : An object describing the location of the item in one of the crates.
154
- * ` additions ` : An array of spans that describe locations where the item has been added.
155
- * ` removals ` : An array of spans that describe locations where the item has been removed.
153
+ - ` name ` : The name of the item.
154
+ - ` def_span ` : An object describing the location of the item in one of the crates.
155
+ - ` additions ` : An array of spans that describe locations where the item has been added.
156
+ - ` removals ` : An array of spans that describe locations where the item has been removed.
156
157
157
158
An example object might look like this:
158
159
@@ -179,15 +180,14 @@ An example object might look like this:
179
180
}
180
181
```
181
182
182
-
183
183
The ` changes ` array contains objects describing all other changes, which have the
184
184
following keys:
185
185
186
- * ` name ` : The name of the item
187
- * ` max_category ` : the most severe change category for this item, as a string.
188
- * Possible values are ` Patch ` , ` NonBreaking ` , ` TechnicallyBreaking ` , and ` Breaking ` .
189
- * ` new_span ` : an object describing the location of the item in the new crate (see example).
190
- * ` changes ` : an array of 2-element sequences containing an error message and an optional
186
+ - ` name ` : The name of the item
187
+ - ` max_category ` : the most severe change category for this item, as a string.
188
+ - Possible values are ` Patch ` , ` NonBreaking ` , ` TechnicallyBreaking ` , and ` Breaking ` .
189
+ - ` new_span ` : an object describing the location of the item in the new crate (see example).
190
+ - ` changes ` : an array of 2-element sequences containing an error message and an optional
191
191
sub-span (` null ` if none is present)
192
192
193
193
An example object might look like this:
@@ -203,22 +203,17 @@ An example object might look like this:
203
203
"col_lo" : 0 ,
204
204
"col_hi" : 1
205
205
},
206
- "changes" : [
207
- [
208
- " trait impl generalized or newly added" ,
209
- null
210
- ]
211
- ]
206
+ "changes" : [[" trait impl generalized or newly added" , null ]]
212
207
}
213
208
```
214
209
215
210
For reference, all objects describing spans have the same keys:
216
211
217
- * ` file ` : A file name.
218
- * ` line_lo ` : The line the span starts on.
219
- * ` line_hi ` : The line the span ends on.
220
- * ` col_lo ` : The column the span starts on.
221
- * ` col_hi ` : The column the span ends on.
212
+ - ` file ` : A file name.
213
+ - ` line_lo ` : The line the span starts on.
214
+ - ` line_hi ` : The line the span ends on.
215
+ - ` col_lo ` : The column the span starts on.
216
+ - ` col_hi ` : The column the span ends on.
222
217
223
218
## Functionality
224
219
@@ -231,24 +226,24 @@ still behave incorrectly in edge-cases. A longterm goal is to fix this in the co
231
226
At the time of writing, the following types of changes are recognized and classified
232
227
correctly:
233
228
234
- * items moving from ` pub ` to non-` pub ` and vice-versa
235
- * items changing their kind, i.e. from a ` struct ` to an ` enum `
236
- * additions and removals of region parameters to and from an item's declaration
237
- * additions and removals of (possibly defaulted) type parameters to and from an item's
229
+ - items moving from ` pub ` to non-` pub ` and vice-versa
230
+ - items changing their kind, i.e. from a ` struct ` to an ` enum `
231
+ - additions and removals of region parameters to and from an item's declaration
232
+ - additions and removals of (possibly defaulted) type parameters to and from an item's
238
233
declaration
239
- * changes to the variance of type and region parameters
240
- * additions and removals of enum variants
241
- * additions and removals of enum variant- or struct fields
242
- * changes from tuple structs or variants to struct variants and vice-versa
243
- * changes to a function or method's constness
244
- * additions and removals of a self-parameter on methods
245
- * additions and removals of (possibly defaulted) trait items
246
- * correct handling of "sealed" traits
247
- * changes to the unsafety of a trait
248
- * type changes of all toplevel items, as well as associated items in inherent impls and
234
+ - changes to the variance of type and region parameters
235
+ - additions and removals of enum variants
236
+ - additions and removals of enum variant- or struct fields
237
+ - changes from tuple structs or variants to struct variants and vice-versa
238
+ - changes to a function or method's constness
239
+ - additions and removals of a self-parameter on methods
240
+ - additions and removals of (possibly defaulted) trait items
241
+ - correct handling of "sealed" traits
242
+ - changes to the unsafety of a trait
243
+ - type changes of all toplevel items, as well as associated items in inherent impls and
249
244
trait definitions
250
- * additions and removals of inherent impls or methods contained therein
251
- * additions and removals of trait impls
245
+ - additions and removals of inherent impls or methods contained therein
246
+ - additions and removals of trait impls
252
247
253
248
Keep in mind however that the results presented to the user are merely an approximation of
254
249
the required versioning policy.
0 commit comments