Parcourir la source

[1751] stats documents update

Naoki Kambe il y a 13 ans
Parent
commit
20fb475bd5
2 fichiers modifiés avec 15 ajouts et 25 suppressions
  1. 6 10
      src/bin/stats/b10-stats.8
  2. 9 15
      src/bin/stats/b10-stats.xml

+ 6 - 10
src/bin/stats/b10-stats.8

@@ -59,23 +59,19 @@ command does not have any configurable settings\&.
 The configuration commands are:
 The configuration commands are:
 .PP
 .PP
 
 
-
-\fBremove\fR
-removes the named statistics name and data\&.
-.PP
-
-
-\fBreset\fR
-will reset all statistics data to default values except for constant names\&. This may re\-add previously removed statistics names\&.
-.PP
-
 \fBset\fR
 \fBset\fR
+will set new statistics data specified in arguments\&. Statistics data to be set and the module name which owns statistics data are required in argument\&. Pid of the module in argument is optional\&.
 .PP
 .PP
 
 
 \fBshow\fR
 \fBshow\fR
 will send the statistics data in JSON format\&. By default, it outputs all the statistics data it has collected\&. An optional item name may be specified to receive individual output\&.
 will send the statistics data in JSON format\&. By default, it outputs all the statistics data it has collected\&. An optional item name may be specified to receive individual output\&.
 .PP
 .PP
 
 
+\fBshowschema\fR
+will send the schema of the statistics data in JSON format\&. The output is equivalent to the statistics part of
+stats\&.spec\&.
+.PP
+
 \fBshutdown\fR
 \fBshutdown\fR
 will shutdown the
 will shutdown the
 \fBb10\-stats\fR
 \fBb10\-stats\fR

+ 9 - 15
src/bin/stats/b10-stats.xml

@@ -101,20 +101,10 @@
     </para>
     </para>
 
 
     <para>
     <para>
-<!-- TODO: remove is removed in trac930 -->
-      <command>remove</command> removes the named statistics name and data.
-    </para>
-
-    <para>
-<!-- TODO: reset is removed in trac930 -->
-      <command>reset</command> will reset all statistics data to
-      default values except for constant names.
-      This may re-add previously removed statistics names.
-    </para>
-
-    <para>
-      <command>set</command>
-<!-- TODO: document this -->
+      <command>set</command> will set new statistics data specified in
+      arguments. Statistics data to be set and the module name which owns
+      statistics data are required in argument. Pid of the module in argument
+      is optional.
     </para>
     </para>
 
 
     <para>
     <para>
@@ -124,7 +114,11 @@
       An optional item name may be specified to receive individual output.
       An optional item name may be specified to receive individual output.
     </para>
     </para>
 
 
-<!-- TODO: document showschema -->
+    <para>
+      <command>showschema</command> will send the schema of the statistics data
+      in JSON format. The output is equivalent to the statistics part
+      of <filename>stats.spec</filename>.
+    </para>
 
 
     <para>
     <para>
       <command>shutdown</command> will shutdown the
       <command>shutdown</command> will shutdown the