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

Export all symbols at crate root as in libc #214

Closed
kamalmarhubi opened this issue Dec 14, 2015 · 1 comment
Closed

Export all symbols at crate root as in libc #214

kamalmarhubi opened this issue Dec 14, 2015 · 1 comment

Comments

@kamalmarhubi
Copy link
Member

As part of implementing RFC 1291, the structure of the libc crate was changed. It now exports all symbols at the top level. I think it's worth considering the same structure for nix.

@Susurrus
Copy link
Contributor

I don't think this makes sense, primarily from a documentation point of view. It's nice being able to provide docs for entire modules for some of the wrapper types that nix implements. It also makes it easier for people from from C to find the man pages. I think it made sense for libc to do this given that they don't care about documentation as they're such a low-level dependency, but for nix we want to have a really good documentation story that includes being able to reuse all the existing docs on libc stuff.

I'm closing this as a WONTFIX because of the above.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants