]> git.puffer.fish Git - mirror/frr.git/commitdiff
quagga: Add Debug Guard section in COMMUNITY.md
authorDonald Sharp <sharpd@cumulusnetworks.com>
Wed, 7 Dec 2016 13:34:38 +0000 (08:34 -0500)
committerDavid Lamparter <equinox@opensourcerouting.org>
Thu, 8 Dec 2016 11:50:25 +0000 (12:50 +0100)
Add verbiage to loosely describe how developers MUST
guard debugs put into their code.

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
COMMUNITY.md

index 0cc8e8d1cef3577704f8e1fd0604d0942dc2765e..cb72ae09df7b8dfa419656f72050023ed98290b8 100644 (file)
@@ -324,3 +324,14 @@ frobnicate ();
 
 Note that the former approach requires ensuring that `SOME_SYMBOL` will be
 defined (watch your `AC_DEFINE`s).
+
+### Debug-Guards in code
+
+Debugs are an important methodology to allow developers to fix issues
+found in the code after it has been released.  The caveat here is
+that the developer must remember that people will be using the code
+at scale and in ways that can be unexpected for the original implementor.
+As such debugs MUST be guarded in such a way that they can be turned off.
+This PROJECT has the ability to turn on/off debugs from the CLI and it is
+expected that the developer will use this convention to allow control
+of their debugs.
\ No newline at end of file