nl80211: add notes about userspace API/ABI modifications
authorJohannes Berg <johannes.berg@intel.com>
Fri, 27 Feb 2015 14:32:43 +0000 (15:32 +0100)
committerJohannes Berg <johannes.berg@intel.com>
Tue, 3 Mar 2015 14:56:06 +0000 (15:56 +0100)
Add notes about userspace ABI/API modifications, including the
fact that we decided that API submissions should come with a
driver implementation.

Signed-off-by: Johannes Berg <johannes.berg@intel.com>
include/uapi/linux/nl80211.h

index 8ee31f10840773b04e15e1ea0951c44715eccc86..90c5aeb3cca75176811a26ca414faa7deb7ecd23 100644 (file)
  *
  */
 
+/*
+ * This header file defines the userspace API to the wireless stack. Please
+ * be careful not to break things - i.e. don't move anything around or so
+ * unless you can demonstrate that it breaks neither API nor ABI.
+ *
+ * Additions to the API should be accompanied by actual implementations in
+ * an upstream driver, so that example implementations exist in case there
+ * are ever concerns about the precise semantics of the API or changes are
+ * needed, and to ensure that code for dead (no longer implemented) API
+ * can actually be identified and removed.
+ * Nonetheless, semantics should also be documented carefully in this file.
+ */
+
 #include <linux/types.h>
 
 #define NL80211_GENL_NAME "nl80211"