Skip to content

Document that system dependencies are ignored #164

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.

Sign up for GitHub

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

Jump to bottom
Closed
sfackler opened this issue Nov 7, 2017 · 4 comments
Closed

Document that system dependencies are ignored #164

sfackler opened this issue Nov 7, 2017 · 4 comments
Labels
E-easy Effort: Should be easy to implement and would make a good first PR

Comments

@sfackler
Copy link
Member

sfackler commented Nov 7, 2017

I thought I had configured docs.rs correctly to install an extra system dependency, but it doesn't seem to have worked:

https://github.com/sfackler/rstack/blob/master/unwind-sys/Cargo.toml#L14
https://docs.rs/crate/unwind-sys/0.1.0/builds/75612

Any idea what's going on there?
@sfackler
Copy link
Member Author

sfackler commented Nov 9, 2017

As far as I can tell, that field isn't actually used anywhere...

@onur
Copy link
Member

onur commented Nov 9, 2017

Yes, installing system dependencies is not a thing ATM and I am not sure it will be in future. I was planning to switch to a docker based build system and use a plain image and dependencies to install whatever needed similar to travis. But it will just cause more headache, people have to maintain correct dependencies all the time and it may be tricky in Debian. And there is no testing suite for docs.rs, even with current simple metadata section, people are forced to upload a new version if they mess up metadata. Because of this I didn't want to implement system dependencies and trying to keep docs.rs as simple as possible.

@pkgw
Copy link

pkgw commented May 16, 2018

It would be helpful to update the documentation to indicate that dependencies doesn't do anything at the moment.

@alexforster alexforster mentioned this issue Jan 14, 2020
Closed
@jyn514 jyn514 changed the title How are system dependencies configured? Document that system dependencies are ignored Feb 1, 2020
@jyn514 jyn514 added the E-easy Effort: Should be easy to implement and would make a good first PR label Feb 1, 2020
@jyn514 jyn514 mentioned this issue Feb 5, 2020
Merged
jyn514 added a commit to jyn514/docs.rs that referenced this issue Feb 5, 2020
@jyn514
remote system dependencies from metadata
695c5fa 
this was causing confusion, see rust-lang#164
jyn514 added a commit that referenced this issue Feb 5, 2020
@jyn514
Remove unused code (#558)
3809f94 
* remove copy_dir

* make utils pub(crate) where possible

* remove dead code in rustc version

* make more things pub(crate)

* only compile ApplyMode::Temporary in test mode

* remove unused argument

* remove unused `handle_html` argument

* don't export metadata

* remove `pub` where possible

* remove unused import

* make create_pool pub(crate)

* fix bad merge

* pub(crate) doesn't make sense in lib.rs

Co-Authored-By: Koenraad Verheyden <mail@koenraadverheyden.com>

* address review comments re: copy test

* remote system dependencies from metadata

this was causing confusion, see #164

* re-comment failing test

* fix failing test

Co-authored-by: Koenraad Verheyden <mail@koenraadverheyden.com>
@jyn514
Copy link
Member

jyn514 commented Feb 5, 2020

This was never documented and is no longer in the code at all.

@jyn514 jyn514 closed this as completed Feb 5, 2020
jyn514 added a commit to jyn514/docs.rs that referenced this issue Feb 6, 2020
@jyn514
Remove unused code (rust-lang#558)
6eda116 
* remove copy_dir

* make utils pub(crate) where possible

* remove dead code in rustc version

* make more things pub(crate)

* only compile ApplyMode::Temporary in test mode

* remove unused argument

* remove unused `handle_html` argument

* don't export metadata

* remove `pub` where possible

* remove unused import

* make create_pool pub(crate)

* fix bad merge

* pub(crate) doesn't make sense in lib.rs

Co-Authored-By: Koenraad Verheyden <mail@koenraadverheyden.com>

* address review comments re: copy test

* remote system dependencies from metadata

this was causing confusion, see rust-lang#164

* re-comment failing test

* fix failing test

Co-authored-by: Koenraad Verheyden <mail@koenraadverheyden.com>
jyn514 added a commit that referenced this issue Feb 8, 2020
@jyn514
Remove unused code (#558)
01f2a26 
* remove copy_dir

* make utils pub(crate) where possible

* remove dead code in rustc version

* make more things pub(crate)

* only compile ApplyMode::Temporary in test mode

* remove unused argument

* remove unused `handle_html` argument

* don't export metadata

* remove `pub` where possible

* remove unused import

* make create_pool pub(crate)

* fix bad merge

* pub(crate) doesn't make sense in lib.rs

Co-Authored-By: Koenraad Verheyden <mail@koenraadverheyden.com>

* address review comments re: copy test

* remote system dependencies from metadata

this was causing confusion, see #164

* re-comment failing test

* fix failing test

Co-authored-by: Koenraad Verheyden <mail@koenraadverheyden.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
E-easy Effort: Should be easy to implement and would make a good first PR
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@pkgw @onur @sfackler @jyn514