Skip to content

Document bitfield usage in the users guide #818

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

Closed
fitzgen opened this issue Jul 17, 2017 · 6 comments
Closed

Document bitfield usage in the users guide #818

fitzgen opened this issue Jul 17, 2017 · 6 comments

Comments

@fitzgen
Copy link
Member

fitzgen commented Jul 17, 2017

Similar to the section on using unions, we should have a section on using bitfields.

@highfive
Copy link

Hi! If you have any questions regarding this issue, feel free to make a comment here, or ask it in the #servo channel in IRC.

If you intend to work on this issue, then add @highfive: assign me to your comment, and I'll assign this to you. 😄

@ambaxter
Copy link
Contributor

@highfive: assign me

@highfive
Copy link

Hey @ambaxter! Thanks for your interest in working on this issue. It's now assigned to you!

@fitzgen
Copy link
Member Author

fitzgen commented Sep 19, 2017

@ambaxter I don't think we have anything in CONTRIBUTING.md about using mdbook yet (another PR opportunity!), but between mdbook's documentation and running mdbook watch from the ./book directory, I think you should be able to figure everything out.

As far as content goes, we should just explain how bitfields get translated from C/C++ into Rust, and how to use them. You can experiment locally and look at the bitfield related tests. High bits are getters, setters, and bitfield unit constructors.

Let me know if you have any questions :)

@fitzgen
Copy link
Member Author

fitzgen commented Sep 25, 2017

@ambaxter making any progress here? Anything I can help with?

@ambaxter
Copy link
Contributor

ambaxter commented Sep 26, 2017

I am making some progress. A few things came up that took my time. Hope to be done in the next day or three.

bors-servo pushed a commit that referenced this issue Jan 17, 2018
Added mdbook entry for bitfields.

Fixes #818
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

4 participants