Add a changelog and an upgrade guide for v2.0. #534
Conversation
|
Thank you for taking the time to write all this up. I agree that a section for 2.x in
Until this project is has a long-term maintainer who wants to commit to maintain changelogs, that statement is simply not true. As such, I would prefer not to have |
| your library or application to the same MSRV. | ||
|
|
||
| * `Url` no longer implements `std::net::ToSocketAddrs`. You will instead need to | ||
| explicitly convert your `Url` to a type that implements `ToSocketAddrs`. |
There was a problem hiding this comment.
Assuming some form of #535 lands, this should reference it instead.
| percent_encoding::utf8_percent_encode(value, PATH_SEGMENT_ENCODE_SET); | ||
| ``` | ||
|
|
||
| You can use the [private encoding sets in the URL parser][encoding-sets] as |
There was a problem hiding this comment.
Well, the whole crate is out of date, isn't it? 😄 But sure, I see your point. Removed.
| const PATH_ENCODE_SET: &AsciiSet = &FRAGMENT_ENCODE_SET | ||
| .add(b'#').add(b'?').add(b'{').add(b'}'); | ||
|
|
||
| const PATH_SEGMENT_ENCODE_SET: &AsciiSet = &PATH_ENCODE_SET.add(b'/').add(b'%'); |
There was a problem hiding this comment.
Since PATH_SEGMENT_ENCODE_SET is not directly in a specification, let’s remove it and PATH_ENCODE_SET here and have the example use FRAGMENT_ENCODE_SET. Let’s also call it FRAGMENT_PERCENT_ENCODE_SET like in the spec, or just FRAGMENT.
There was a problem hiding this comment.
All notable changes to the […] package will be documented in this file.
Until this project is has a long-term maintainer who wants to commit to maintain changelogs, that statement is simply not true. As such, I would prefer not to have
CHANGELOG.mdfiles.
Understood. I've extracted the unobjectionable part into #538.
On a meta-note, I find it pretty worrying that this crate doesn't have a maintainer! I wasn't aware that was the case, but I see now that you've been looking for a long-term maintainer for two years, yikes! Hmmmmm. Maybe I can find some time. What would be most helpful in the short term? Still triaging issues and reviewing PRs? Or actually trying to address some of the issues in the backlog?
| your library or application to the same MSRV. | ||
|
|
||
| * `Url` no longer implements `std::net::ToSocketAddrs`. You will instead need to | ||
| explicitly convert your `Url` to a type that implements `ToSocketAddrs`. |
| percent_encoding::utf8_percent_encode(value, PATH_SEGMENT_ENCODE_SET); | ||
| ``` | ||
|
|
||
| You can use the [private encoding sets in the URL parser][encoding-sets] as |
There was a problem hiding this comment.
Well, the whole crate is out of date, isn't it? 😄 But sure, I see your point. Removed.
Welcome to open-source ¯\_(ツ)_/¯ |
Add an upgrade guide for v2.0. Extracted from #534, with review feedback addressed. This variant omits the changelogs in an effort to introduce less of a maintenance burden. Fix #532. <!-- Reviewable:start --> --- This change is [<img src="https://reviewable.io/review_button.svg" height="34" align="absmiddle" alt="Reviewable"/>](https://reviewable.io/reviews/servo/rust-url/536) <!-- Reviewable:end -->
|
☔ The latest upstream changes (presumably #536) made this pull request unmergeable. Please resolve the merge conflicts. |
|
Moved to #536 |
See #532 for context. Having this available would have been a huge help when upgrading to url v2.0, and I wanted to save others the pain. I left a few TODOs where I'll need someone else to explain the impact of a change.
Fix #532.
This change is