]> git.puffer.fish Git - matthieu/frr.git/commitdiff
frr: Modify doc to talk about cli
authorDonald Sharp <sharpd@cumulusnetworks.com>
Fri, 16 Dec 2016 20:35:14 +0000 (15:35 -0500)
committerDonald Sharp <sharpd@cumulusnetworks.com>
Fri, 16 Dec 2016 20:35:14 +0000 (15:35 -0500)
Add some verbiage to the COMMUNITY.md to talk
about the philosophy of what cli should do.

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
COMMUNITY.md

index 7d08ed58dc0b290d21bcd1804178ac3b9617f219..52777da968810928ee2e13247beac7613bb87782 100644 (file)
@@ -300,4 +300,11 @@ 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
+of their debugs.
+
+### CLI-Changes
+
+CLI's are a complicated ugly beast.  Additions or changes to the CLI
+should use a DEFUN to encapsulate one setting as much as is possible.
+Additionally as new DEFUN's are added to the system, documentation
+should be provided for the new commands.
\ No newline at end of file