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

Move FFI documentation from the Book to the Nomicon #42064

Closed
QuietMisdreavus opened this issue May 17, 2017 · 1 comment
Closed

Move FFI documentation from the Book to the Nomicon #42064

QuietMisdreavus opened this issue May 17, 2017 · 1 comment

Comments

@QuietMisdreavus
Copy link
Member

After some discussions in the docs team meetings about #31227, it became clear that FFI documentation doesn't really have a good place any more. The second edition of TRPL decided not to include a follow-up to the FFI discussion that the first edition had. Therefore, once that gets published and more or less supplants the first edition, we risk losing that documentation entirely. Moving it to the Nomicon (in lieu of its own standalone book or some other location) does make some sense, as it requires an understanding of unsafe code.

From there it can be expanded with more up-to-date information, possibly also including extra sources like the Rust FFI Omnibus or similar projects.

@QuietMisdreavus
Copy link
Member Author

Getting this working basically involves copying the FFI chapter out of rust-lang/book and into rust-lang-nursery/nomicon. In the docs team discussion, @steveklabnik said it would be best to leave the 1st edition book as-is, since it's intended to be fairly static now that the 2nd edition is nearly finished, so you wouldn't even need to take it out from the book.

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

No branches or pull requests

1 participant