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

crates.io build script guide: optional dependencies mistake? #2191

Closed
hobofan opened this issue Dec 3, 2015 · 3 comments · Fixed by #4033
Closed

crates.io build script guide: optional dependencies mistake? #2191

hobofan opened this issue Dec 3, 2015 · 3 comments · Fixed by #4033
Labels
A-documenting-cargo-itself Area: Cargo's documentation

Comments

@hobofan
Copy link

hobofan commented Dec 3, 2015

In the "Linking to system libraries" example of the build script guide it says:

It has a optional dependency on libssh2 on all platforms to implement the ssh transport.

A few lines later there is a contradicting statement while still talking about the same example:

Here we also see the unconditional dependency on libssh2 via the libssh2-sys crate

Am I missing something or should the former also read "unconditional dependency"?

@steveklabnik
Copy link
Member

I think you're correct.

@alexcrichton
Copy link
Member

This is actually intentional, but I think the antecedents may not be clear enough. "It" in the optional part is referring to libgit2 itself whereas later the "it" is the Rust crate which chose to have an unconditional instead of optional dependency.

@alexcrichton alexcrichton added the A-documenting-cargo-itself Area: Cargo's documentation label Dec 3, 2015
@alexcrichton
Copy link
Member

(I can see where this is confusing though!)

bors added a commit that referenced this issue May 12, 2017
Clear up Linking to Systems Libraries docs

Fixes #2191.
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