Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs for * deps don't mention locally vs crates.io #3971

Closed
steveklabnik opened this issue Apr 28, 2017 · 3 comments · Fixed by #7733
Closed

docs for * deps don't mention locally vs crates.io #3971

steveklabnik opened this issue Apr 28, 2017 · 3 comments · Fixed by #7733
Labels
A-documenting-cargo-itself Area: Cargo's documentation

Comments

@steveklabnik
Copy link
Member

reported here https://news.ycombinator.com/item?id=14217327

@steveklabnik steveklabnik added the A-documenting-cargo-itself Area: Cargo's documentation label Apr 28, 2017
@carols10cents
Copy link
Member

Copy pasting because I've been bitten by bug reports linking to something that went away:

The version requirement in the cargo.toml file under [dependencies] is

chrono="*"

which, according to this manual [1] is valid.

[1] http://doc.crates.io/specifying-dependencies.html

Yes, star dependencies were removed like a year ago, for semver issues. They went through multiple release cycles of warnings.

From the Cargo manual [1]:

Wildcard requirements

Wildcard requirements allow for any version where the wildcard is positioned.

, 1. and 1.2.* are examples of wildcard requirements.

  • := >=0.0.0
    1.* := >=1.0.0 <2.0.0
    1.2.* := >=1.2.0 <1.3.0

Apparently, nobody bothered to update the manual after removing the feature.

[1] http://doc.crates.io/specifying-dependencies.html

Second, the Cargo star dependencies report. Manishearth is wrong, we disallow those dependencies from being uploaded to crates.io, but end users are allowed to use them just fine (strongly recommended that you don't, though!).

@alexcrichton
Copy link
Member

Just to make sure I understand, sounds like we should update the documentation for crates.io that * dependencies are disallowed, but that's the only change?

@carols10cents
Copy link
Member

Just to make sure I understand, sounds like we should update the documentation for crates.io that * dependencies are disallowed, but that's the only change?

Pretty much, yeah, we should clarify that * dependencies are allowed in general but are disallowed if you publish your crate to crates.io.

bors added a commit that referenced this issue Dec 22, 2019
Various doc updates

This is a collection of documentation updates that have been in my todo list for a while. Each change is in a separate commit.

The "features" chapter will probably get significant changes in the future, as it is pretty bare right now. Similarly the "workspace" chapter could probably use more examples.

Closes #3062
Closes #3817
Closes #3971
Closes #4212
Closes #4438
Closes #4756
Closes #5822
Closes #6913
Closes #7055
@bors bors closed this as completed in 2a4aa42 Dec 22, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-documenting-cargo-itself Area: Cargo's documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants