From: Donald Sharp Date: Fri, 16 Dec 2016 20:35:14 +0000 (-0500) Subject: frr: Modify doc to talk about cli X-Git-Tag: frr-2.0-rc1~19^2 X-Git-Url: https://git.puffer.fish/?a=commitdiff_plain;h=19c7f43feb43290ee945fb965e88a9b03722dbf8;p=matthieu%2Ffrr.git 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 --- 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