[sr-dev] git:master: mtree: docs updated for mtree.summary

Daniel-Constantin Mierla miconda at gmail.com
Tue Apr 22 16:08:44 CEST 2014


Module: sip-router
Branch: master
Commit: 910224d3d55ee225628e57e8da8fbff648cd7977
URL:    http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=910224d3d55ee225628e57e8da8fbff648cd7977

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date:   Tue Apr 22 16:07:28 2014 +0200

mtree: docs updated for mtree.summary

---

 modules/mtree/README              |    6 ++++--
 modules/mtree/doc/mtree_admin.xml |   10 +++++++---
 2 files changed, 11 insertions(+), 5 deletions(-)

diff --git a/modules/mtree/README b/modules/mtree/README
index e49d699..b0a6543 100644
--- a/modules/mtree/README
+++ b/modules/mtree/README
@@ -412,9 +412,11 @@ mt_match("mytree", "$rU", "0");
 
 6.1. mtree.summary
 
-   List usage summary for all trees.
+   List usage summary for all trees or for the tree whose name is given as
+   parameter.
 
-   Parameters: none.
+   Parameters:
+     * _mtree_ - (optional) the name of the tree.
 
 6.2. mtree.reload
 
diff --git a/modules/mtree/doc/mtree_admin.xml b/modules/mtree/doc/mtree_admin.xml
index b008a35..cf91bbc 100644
--- a/modules/mtree/doc/mtree_admin.xml
+++ b/modules/mtree/doc/mtree_admin.xml
@@ -468,9 +468,13 @@ mt_match("mytree", "$rU", "0");
 		<function moreinfo="none">mtree.summary</function>
 		</title>
 		<para>
-		List usage summary for all trees.
+			List usage summary for all trees or for the tree whose name is
+			given as parameter.
 		</para>
-		<para>Parameters: none.</para>
+		<para>Parameters:</para>
+		<itemizedlist>
+			<listitem><para>_mtree_ - (optional) the name of the tree.</para></listitem>
+		</itemizedlist>
         </section>
 	<section>
 		<title>
@@ -481,7 +485,7 @@ mt_match("mytree", "$rU", "0");
 		</para>
 		<para>Parameters:</para>
 		<itemizedlist>
-			<listitem><para>_mtree_</para> - name of mtree or empty string meaning all mtrees</listitem>	  
+			<listitem><para>_mtree_</para> - name of mtree or empty string meaning all mtrees</listitem>
 		</itemizedlist>
         </section>
     <section>




More information about the sr-dev mailing list