summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDonald Sharp <sharpd@cumulusnetworks.com>2016-12-16 15:35:14 -0500
committerDonald Sharp <sharpd@cumulusnetworks.com>2016-12-16 15:35:14 -0500
commit19c7f43feb43290ee945fb965e88a9b03722dbf8 (patch)
tree31753915e7021fc15b16777b6d129588147b750d
parent5c3cc3ae96885f2671a0c520ee93d724bd51da50 (diff)
frr: Modify doc to talk about cli
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>
-rw-r--r--COMMUNITY.md9
1 files changed, 8 insertions, 1 deletions
diff --git a/COMMUNITY.md b/COMMUNITY.md
index 7d08ed58dc..52777da968 100644
--- a/COMMUNITY.md
+++ b/COMMUNITY.md
@@ -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