Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

frr: Modify doc to talk about cli #7

Merged
merged 1 commit into from
Dec 20, 2016
Merged

frr: Modify doc to talk about cli #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion COMMUNITY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just to make it super explicit, perhaps:

"Unrelated CLI definitions should not be bundled together."

Additionally as new DEFUN's are added to the system, documentation
should be provided for the new commands.