[riot-notifications] [RIOT-OS/RIOT] doc/memos: RDM Runtime Configuration Architecture (#10622)

danpetry notifications at github.com
Mon Jan 14 15:30:10 CET 2019


danpetry commented on this pull request.



> +    if(is_enabled) {
+        trigger_something();
+    }
+    
+    /* As stated before, the application crashes if `set_threashold` is called when is_enabled is false.
+    We protect it here */
+    if(is_enabled) {
+        /* We can safely set the theshold without crashing the app */
+        set_threshold(threshold);
+    }
+}
+
+/* Dummy implementation of `export` handler.
+   This handler has to call `export_func` for one or all parameters.
+   There can be different behaviors depending on the export function (e.g printing all configs
+   to STDOUT, save them in a non-volatile storage device, etc)

ok, from my point of view I had to re-read this function a few times to understand - the suggestion was to help make it clearer so people can digest it as easily as possible. Stating things explicitly rather than implicitly makes it a lot easier
Lots of the comments I left aren't about correctness - they're about having a document where people can read it with zero input from any maintainer, and know exactly what they're bound to do by the RDM (and what they're free to do as they wish).

-- 
You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub:
https://github.com/RIOT-OS/RIOT/pull/10622#discussion_r247511775
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.riot-os.org/pipermail/notifications/attachments/20190114/a9559b90/attachment.html>


More information about the notifications mailing list