Update hooks-stat-cmds.xml

diff --git a/doc/guide/hooks-stat-cmds.xml b/doc/guide/hooks-stat-cmds.xml
index d4604c47371eb86365bb305b05c2111f817f5a6f..18002dbccf7867e3e24b31edae4284a6dcd9098a 100644 (file)
--- a/doc/guide/hooks-stat-cmds.xml
+++ b/doc/guide/hooks-stat-cmds.xml
@@ -2,24 +2,23 @@
   <title>stat_cmds: Supplemental Statistics Commands</title>
   <para>
     This library provides additional statistics commands for
-    retrieving lease statistics from Kea DHCP servers.  These commands
+    retrieving lease statistics from Kea DHCP servers. These commands
     were added to address an issue with obtaining accurate lease
-    statistics in deployments running multiple Kea servers that use
-    shared lease back end.  The in-memory statistics kept by individual
-    servers only track lease changes made by that server.  Thus in a
+    statistics in deployments running multiple Kea servers that use a
+    shared lease backend. The in-memory statistics kept by individual
+    servers only track lease changes made by that server; thus, in a
     deployment with multiple servers (e.g. two kea-dhcp6 servers using the
     same PostgreSQL database for lease storage), these statistics are incomplete.
-    In Kea 1.4, the MySQL and PostgreSQL back ends were modified to track
+    The MySQL and PostgreSQL backends were modified in Kea to track
     lease allocation changes as they occur via database triggers. Additionally,
-    all four lease back ends were extended to support retrieving lease
+    all four lease backends were extended to support retrieving lease
     statistics for all subnets, a single subnet, or a range of subnets.
     Finally, this library was constructed to provide commands for retrieving
-    these statistics.  Additional statistics commands may be added to this
-    library in future releases.
+    these statistics.
 
     <note>
-      <para>This library may only be loaded by <command>kea-dhcp4</command>
-      or <command>kea-dhcp6</command> process.
+      <para>This library may only be loaded by the <command>kea-dhcp4</command>
+      or the <command>kea-dhcp6</command> process.
       </para>
     </note>
   </para>
@@ -42,9 +41,9 @@
   </para>
 
   <para>
-    All commands use JSON syntax and can be issued either directly to
-    the servers via the control channel (see <xref linkend="ctrl-channel"/>)
-    or via Control Agent (see <xref linkend="kea-ctrl-agent"/>).
+    All commands use JSON syntax and can be issued directly to
+    the servers via either the control channel (see <xref linkend="ctrl-channel"/>)
+    or the Control Agent (see <xref linkend="kea-ctrl-agent"/>).
   </para>
 
   <para>
@@ -67,42 +66,42 @@
 
   <para>
     In a deployment with multiple Kea DHCP servers sharing a common lease
-    storage, it may be loaded by any or all of the servers.  However, one
+    storage, it may be loaded by any or all of the servers. However, one
     thing to keep in mind is that a server's response to a stat-lease{4/6}-get
-    command will only contain data for subnets known to that server.  In
-    other words, if subnet does not appear in a server's configuration, it
+    command will only contain data for subnets known to that server. In
+    other words, if a subnet does not appear in a server's configuration, Kea
     will not retrieve statistics for it.
  </para>
 
 <section id="command-stat-lease4-get">
-  <title>stat-lease4-get, stat-lease6-get commands</title>
+  <title>stat-lease4-get, stat-lease6-get Commands</title>
     <para id="command-stat-lease6-get">
       The <command>stat-lease4-get</command> and <command>stat-lease6-get</command>
-      commands fetch lease statistics for a range of known subnets.  The
+      commands fetch lease statistics for a range of known subnets. The
       range of subnets is determined through the use of optional command
       input parameters:
       <itemizedlist>
           <listitem>
-            <para><command>subnet-id</command> - ID of the subnet for which
+            <para><command>subnet-id</command> - The ID of the subnet for which
             lease statistics should be fetched. Use this to get statistics for
-            a single subnet.  If the subnet does not exist the command result
+            a single subnet. If the subnet does not exist, the command result
             code will be 3 (i.e. CONTROL_RESULT_EMPTY).
             </para>
           </listitem>
           <listitem>
             <para><command>subnet-range</command> - A pair of subnet IDs which
             describe an inclusive range of subnets for which statistics should
-            be retrieved.  Note that fuzzy values are supported thus allowing
+            be retrieved. Note that fuzzy values are supported, thus allowing
             for a query for statistics using approximate ID values. If the
             range does not include any known subnets, the command result code
             will be 3 (i.e. CONTROL_RESULT_EMPTY).
             <itemizedlist>
               <listitem>
-                <para><command>first-subnet-id</command> - ID of the first
+                <para><command>first-subnet-id</command> - The ID of the first
                 subnet in the range.</para>
               </listitem>
               <listitem>
-                <para><command>last-subnet-id</command> - ID of the first
+                <para><command>last-subnet-id</command> - The ID of the last
                 subnet in the range.</para>
               </listitem>
             </itemizedlist>
@@ -111,11 +110,11 @@
         </itemizedlist>
         The use of subnet-id and subnet-range are mutually exclusive.
         If no parameters are given, the result will contain data for all
-        known subnets.  Note that in configurations with large numbers of
-        subnets, this can be result in a large response.
+        known subnets. Note that in configurations with large numbers of
+        subnets, this can result in a large response.
     </para>
     <para>
-      The following command would fetch lease statistics for all known subnets from kea-dhcp4 server:
+      The following command would fetch lease statistics for all known subnets from a kea-dhcp4 server:
 <screen>
 {
   "command": "stat-lease4-get"
@@ -123,7 +122,7 @@
 </screen>
     </para>
     <para>
-        The following command would fetch lease statistcis for subnet ID 10 from kea-dhcp6 server:
+        The following command would fetch lease statistcis for subnet ID 10 from a kea-dhcp6 server:
 <screen>
 {
   "command": "stat-lease6-get",
@@ -134,7 +133,7 @@
 </screen>
     </para>
     <para>
-        The following command would fetch lease statistcis for all subnets from subnet ID 10 through 50 from kea-dhcp4 server:
+        The following command would fetch lease statistics for all subnets from subnet IDs 10 through 50 from a kea-dhcp4 server:
 <screen>
 {
   "command": "stat-lease4-get",
@@ -149,16 +148,16 @@
     </para>
 
     <para>
-      The response to the either command will contain three elements:
+      The response to either command will contain three elements:
       <itemizedlist>
         <listitem>
-          <para><command>result</command> - numeric value indicating the outcome of the
+          <para><command>result</command> - a numeric value indicating the outcome of the
           command where:
           <itemizedlist>
-            <listitem><simpara><command>0</command> - command was successful</simpara></listitem>
+            <listitem><simpara><command>0</command> - the command was successful;</simpara></listitem>
             <listitem><simpara><command>1</command> - an error occurred, an explanation will
-            be the "text" element</simpara></listitem>
-            <listitem><simpara><command>2</command> - indicates the fetch found no matching data</simpara></listitem>
+            be the "text" element;</simpara></listitem>
+            <listitem><simpara><command>2</command> - the fetch found no matching data</simpara></listitem>
           </itemizedlist>
           </para>
         </listitem>
@@ -168,12 +167,12 @@
         </listitem>
         <listitem>
           <para><command>arguments</command> - a map containing the data returned by the
-          command as the element "result-set", which patterned after SQL statement responses:
+          command as the element "result-set", which is patterned after SQL statement responses:
           <itemizedlist>
-            <listitem><para><command>columns</command> - a list of text column labels.
+            <listitem><para><command>columns</command> - a list of text column labels
             The columns returned for DHCPv4 are:
             <itemizedlist>
-              <listitem><simpara><command>subnet-id</command> - ID of the subnet</simpara></listitem>
+              <listitem><simpara><command>subnet-id</command> - ID of the subnet.</simpara></listitem>
               <listitem><simpara><command>total-addresses</command> - total number of addresses
               available for DHCPv4 management in the subnet. In other words, this is the sum of all
               addresses in all the configured pools in the subnet.</simpara></listitem>
@@ -186,7 +185,7 @@
             </listitem>
           <listitem><para>The columns returned for DHCPv6 are:
             <itemizedlist>
-              <listitem><simpara><command>subnet-id</command> - ID of the subnet</simpara></listitem>
+              <listitem><simpara><command>subnet-id</command> - ID of the subnet.</simpara></listitem>
               <listitem><simpara><command>total-nas</command> - number of NA addresses available
               for DHCPv6 management in the subnet. In other words, this is the sum of all
               the NA addresses in the all configured NA pools in the subnet.</simpara></listitem>
@@ -202,11 +201,11 @@
             </itemizedlist></para>
             </listitem>
             <listitem><para><command>rows</command> - a list of rows, one per subnet ID. Each row
-            contains a data value for corresponding to and in the same order as each column
+            contains a data value corresponding to and in the same order as each column
             listed in "columns" for a given subnet.
             </para></listitem>
             <listitem><para><command>timestamp</command> - textual date and time the data was fetched,
-            expressed as GMT</para></listitem>
+            expressed as GMT.</para></listitem>
           </itemizedlist>
         </para>
       </listitem>