Consider yanking outdated alpha crates and linking to the correct module

[udoprog]

Since #1264 - most crates have been moved back into one. However, alpha versions of the old crates are still around causing confusion. When going to https://docs.rs/tokio-process (early Google hit) you're not directed to the last stable version. Instead you get 0.3.0-alpha.2 without any indication that the crate has been deprecated in the latest version of tokio. This also makes it difficult to navigate to the last 0.1.x compatible version in case you need to.

Consider doing the following:

• Yank outdated alpha crates.
• Create a new release of outdated 0.1.x compatible crates pointing to documentation showing how the new structure in 0.2.x with features should be used instead.

Non-exhaustive list of affected crates:

• https://docs.rs/tokio-process (tokio::process, feature = "process").
  • Deprecation notice (merge and add deprecation notice Merge tokio-process into v0.1.x #2100).
  • Yank alpha versions.
  • Publish new version of outdated crate.
• https://docs.rs/tokio-reactor (tokio::runtime?).
  • Deprecation notice (Add deprecation notices for outdated crates (#2036) #2097, More deprecation notices (relates #2036) #2098)
  • Yank alpha versions.
  • Publish new version of outdated crate.
• https://docs.rs/tokio-executor (tokio::runtime?).
  • Deprecation notice (Add deprecation notices for outdated crates (#2036) #2097, More deprecation notices (relates #2036) #2098)
  • Yank alpha versions.
  • Publish new version of outdated crate.
• https://docs.rs/tokio-threadpool (tokio::runtime?).
  • Deprecation notice (Add deprecation notices for outdated crates (#2036) #2097, More deprecation notices (relates #2036) #2098)
  • Yank alpha versions.
  • Publish new version of outdated crate.
• https://docs.rs/tokio-signal (tokio::signal, feature = "signal").
  • Deprecation notice (Add deprecation notices for outdated crates (#2036) #2097, More deprecation notices (relates #2036) #2098)
  • Yank alpha versions.
  • Publish new version of outdated crate.
• https://docs.rs/tokio-timer (tokio::time, feature = "time").
  • Deprecation notice (Add deprecation notices for outdated crates (#2036) #2097, More deprecation notices (relates #2036) #2098)
  • Yank alpha versions.
  • Publish new version of outdated crate.
• https://docs.rs/tokio-tcp (tokio::net::tcp, feature = "tcp").
  • Deprecation notice (Add deprecation notices for outdated crates (#2036) #2097, More deprecation notices (relates #2036) #2098)
  • Yank alpha versions.
  • Publish new version of outdated crate.
• https://docs.rs/tokio-udp (tokio::net::udp, feature = "udp").
  • Deprecation notice (Add deprecation notices for outdated crates (#2036) #2097, More deprecation notices (relates #2036) #2098)
  • Yank alpha versions.
  • Publish new version of outdated crate.
• https://docs.rs/tokio-uds (tokio::net::unix, feature = "uds").
  • Deprecation notice (Add deprecation notices for outdated crates (#2036) #2097, More deprecation notices (relates #2036) #2098)
  • Yank alpha versions.
  • Publish new version of outdated crate.
• https://docs.rs/tokio-sync (tokio::sync, feature = "sync").
  • Deprecation notice (Add deprecation notices for outdated crates (#2036) #2097, More deprecation notices (relates #2036) #2098)
  • Yank alpha versions.
  • Publish new version of outdated crate.
• https://docs.rs/tokio-codec (tokio_util::codec, feature = "codec").
  • Deprecation notice (Add deprecation notices for outdated crates (#2036) #2097, More deprecation notices (relates #2036) #2098)
  • Yank alpha versions.
  • Publish new version of outdated crate.
• https://docs.rs/tokio-buf (deprecated)
  • Deprecation notice (More deprecation notices (relates #2036) #2098)
  • Yank alpha versions.
  • Publish new version of outdated crate.
• https://docs.rs/tokio-current-thread (replaced with Runtime + LocalSet)
  • Deprecation notice (More deprecation notices (relates #2036) #2098)
  • Yank alpha versions.
  • Publish new version of outdated crate.

[Darksonn]

Being very active on the Rust user forum, I have answered the question of what happened to codec quite a few times. It would be really nice to have the doc for tokio-codec point to the correct location.

[Darksonn]

One alternative to yanking would be to add both a new 0.1.x version and a new 0.2.0-alpha.x version, both explaining updates adding text to explain where to find the version you probably want.

Note also that version 0.2.0-alpha.6 of tokio-codec failed to build properly on docs.rs for some reason, so docs.rs shows the doc for 0.2.0-alpha.5 instead.

[LucioFranco]

This seems like a fantastic idea 👍

[udoprog]

tokio-process no longer exists in the tokio repo, so in order to make a change we might have to incorporate into this organization, or move it into the 0.1.x branch of the tokio crate.

Thoughts?

[LucioFranco]

@udoprog moving it into 0.1.x I think makes sense? Where does it live now?

[carllerche]

These changes can happen in the 0.1.x branch. I would add deprecation notices in the readme, lib.rs docs then publish.

[udoprog]

@udoprog moving it into 0.1.x I think makes sense? Where does it live now?

It seems like it was moved into tokio while 0.2.x was being built, but eventually dropped in favor of merging it into the tokio crate. So it seems like the latest tokio-process crate was published from https://github.com/alexcrichton/tokio-process. Moving this into the 0.1.x branch as the other crates seems like the right thing to do.

[LucioFranco]

that seems fine, we should add a note and appropriate license information but otherwise sounds good 👍

[udoprog]

Added notices to lib.rs as well in #2098

[udoprog]

tokio-process with deprecation notice added in #2100

[LucioFranco]

This has all been done, thanks for the help @udoprog

[jebrosen]

As far as I can tell rereleases weren't made for the -alpha.* versions, and those are still causing some confusion. For example, the tokio-process page https://docs.rs/tokio-process/0.2.5/tokio_process/ has that big scary button at the top "⚠ Go to latest version". At least for me, this is a bit of a "reflex click" before even reading the first page. The result then is "skipping" over the deprecation warning into the outdated docs at https://docs.rs/tokio-process/0.3.0-alpha.2/tokio_process/index.html. The same is true for tokio-codec as well; I haven't tested any others.

Would it be possible to make those re-releases as well?