[PATCH weston v5 05/11] compositor: Document refs for alternatives/assumptions for backend configs

[Bryce Harrington]

Signed-off-by: Bryce Harrington <bryce at osg.samsung.com>
---
 src/compositor.h | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/src/compositor.h b/src/compositor.h
index f93d76a..45ffb6c 100644
--- a/src/compositor.h
+++ b/src/compositor.h
@@ -682,6 +682,12 @@ struct weston_backend_output_config {
  * passed to the backend's init entry point. The backend will
  * likely want to subclass this in order to handle backend specific
  * data.
+ *
+ * NOTE: Alternate designs were proposed (Feb 2016) for using opaque
+ * structures and for section+key/value getter/setters.  The rationale
+ * for selecting the transparent structure design is based on several
+ * assumptions which may require re-evaluating the design choice if they
+ * fail to hold.
  */
 struct weston_backend_config {
    /** Major version for the backend-specific config struct
-- 
1.9.1