summaryrefslogtreecommitdiff
path: root/CONVENTIONS.md
diff options
context:
space:
mode:
authorPhilipp Matthias Schaefer <philipp.matthias.schaefer@posteo.de>2016-01-29 19:49:13 +0100
committerKamal Marhubi <kamal@marhubi.com>2016-02-01 16:24:19 -0500
commitc3cecb8e42e4593f55f6d57218fd0a346e481654 (patch)
tree4183a9dd922df85202ae3e6c8d43328abc64c841 /CONVENTIONS.md
parent9382f342a37f59b099e1c6a69a946e20c9f5ee41 (diff)
downloadnix-c3cecb8e42e4593f55f6d57218fd0a346e481654.zip
Add file detailing conventions for nix.
Diffstat (limited to 'CONVENTIONS.md')
-rw-r--r--CONVENTIONS.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/CONVENTIONS.md b/CONVENTIONS.md
new file mode 100644
index 00000000..dcdb2cec
--- /dev/null
+++ b/CONVENTIONS.md
@@ -0,0 +1,8 @@
+# Bitflags
+
+We represent sets of constants whose values are mutually exclusive on a bit
+level -- that is, for all flags `A` and `B` of the set with `A != B` holds
+`A & B = 0` -- by types defined using the `bitflags!` macro from the
+[bitflags crate](https://crates.io/crates/bitflags/).
+Instead of providing the concrete values ourselves, we prefer taking the
+constants defined in [libc crate](https://crates.io/crates/libc/).