Skip to content

A few additions to the CONVENTIONS file #287

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

Merged
merged 2 commits into from
Feb 29, 2016
Merged

A few additions to the CONVENTIONS file #287

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d4575c5
Document naming convention for flag types.
fiveop Feb 29, 2016
3835777
Extend section on constants to include functions and structs.
fiveop Feb 29, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion CONVENTIONS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,24 @@ of either, feel free to remedy the flaw by opening a pull request with
appropriate changes or additions.


## Integer Constants
## libc constants, functions and structs

We do not define integer constants ourselves, but use or reexport them from the
[libc crate][libc].

We use the functions exported from [libc][libc] instead of writing our own
`extern` declarations.

We use the `struct` definitions from [libc][libc] internally instead of writing
our own.

## Bitflags

We represent sets of constants that are intended to be combined using bitwise
operations as parameters to functions by types defined using the `bitflags!`
macro from the [bitflags crate][bitflags].
We name the type for a set of constants whose element's names start with `FOO_`
`FooFlags`.


## Enumerations
Expand Down