From c3cecb8e42e4593f55f6d57218fd0a346e481654 Mon Sep 17 00:00:00 2001
From: Philipp Matthias Schaefer <philipp.matthias.schaefer@posteo.de>
Date: Fri, 29 Jan 2016 19:49:13 +0100
Subject: Add file detailing conventions for nix.

---
 CONVENTIONS.md | 8 ++++++++
 1 file changed, 8 insertions(+)
 create mode 100644 CONVENTIONS.md

(limited to 'CONVENTIONS.md')

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/).
-- 
cgit v1.2.3