summaryrefslogtreecommitdiff
path: root/doc/CODING-GUIDELINES
diff options
context:
space:
mode:
authorKevin P. Fleming <kpfleming@digium.com>2005-04-01 04:38:12 +0000
committerKevin P. Fleming <kpfleming@digium.com>2005-04-01 04:38:12 +0000
commit93c8e08989ef9b8bc23c7286e744182428006010 (patch)
treee295e0da2756e95a8e8d8f93fe20b41fa0501b11 /doc/CODING-GUIDELINES
parent6e764dc0976c70982a80e01bdf0987181fb7bf66 (diff)
Update README to reflect modern Asterisk features and requirements
Add note in UPGRADE.txt about compiler requirements Add note to CODING-GUIDELINES about new policy for CLI command structure git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@5335 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'doc/CODING-GUIDELINES')
-rwxr-xr-xdoc/CODING-GUIDELINES12
1 files changed, 11 insertions, 1 deletions
diff --git a/doc/CODING-GUIDELINES b/doc/CODING-GUIDELINES
index 175fb5380..f115094d0 100755
--- a/doc/CODING-GUIDELINES
+++ b/doc/CODING-GUIDELINES
@@ -78,7 +78,6 @@ for (x=0;x<5;x++) {
}
-
Make sure you never use an uninitialized variable. The compiler will
usually warn you if you do so.
@@ -154,3 +153,14 @@ if (name && (len = strlen(name) + strlen(prefix) + strlen(postfix) + 3) && (newn
Use const on pointers which your function will not be modifying, as this
allows the compiler to make certain optimizations.
+
+== CLI Commands ==
+
+New CLI commands should be named using the module's name, followed by a verb
+and then any parameters that the command needs. For example:
+
+*CLI> iax2 show peer <peername>
+
+not
+
+*CLI> show iax2 peer <peername>