From: Jeremy C. Reed <jreed@isc.org>
Date: Mon, 21 Sep 2015 15:06:15 +0000 (-0500)
Subject: Improve docs for zone-statistics
X-Git-Tag: v9.11.0a1~448
X-Git-Url: http://git.ipfire.org/gitweb/?a=commitdiff_plain;h=5c41d472275c096be8aafb239a301b9d7c0a2cd9;p=thirdparty%2Fbind9.git

Improve docs for zone-statistics

This is for ticket #36955.
Improve grammar for zone-statistics to list new arguments.
Refer to the docs in the options section.
Clarify about stats may not show view name.
---

diff --git a/CHANGES b/CHANGES
index 5abde3fc7d8..367264caea6 100644
--- a/CHANGES
+++ b/CHANGES
@@ -1,3 +1,6 @@
+4220.	[doc]		Improve documentaion for zone-statistics.
+			[RT #36955]
+
 4219.	[bug]		Set event->result to ISC_R_WOULDBLOCK on EWOULDBLOCK,
 			EGAIN when these soft error are not retried for
 			isc_socket_send*().
diff --git a/doc/arm/Bv9ARM-book.xml b/doc/arm/Bv9ARM-book.xml
index 3866a01ae4b..3570c30e69a 100644
--- a/doc/arm/Bv9ARM-book.xml
+++ b/doc/arm/Bv9ARM-book.xml
@@ -11792,7 +11792,7 @@ zone <replaceable>zone_name</replaceable> <optional><replaceable>class</replacea
     <optional> alt-transfer-source-v6 (<replaceable>ip6_addr</replaceable> | <constant>*</constant>)
 			    <optional>port <replaceable>ip_port</replaceable></optional> <optional>dscp <replaceable>ip_dscp</replaceable></optional> ; </optional>
     <optional> use-alt-transfer-source <replaceable>yes_or_no</replaceable>; </optional>
-    <optional> zone-statistics <replaceable>yes_or_no</replaceable> ; </optional>
+    <optional> zone-statistics <replaceable>full</replaceable> | <replaceable>terse</replaceable> | <replaceable>none</replaceable>; </optional>
     <optional> database <replaceable>string</replaceable> ; </optional>
     <optional> min-refresh-time <replaceable>number</replaceable> ; </optional>
     <optional> max-refresh-time <replaceable>number</replaceable> ; </optional>
@@ -11806,7 +11806,7 @@ zone <replaceable>zone_name</replaceable> <optional><replaceable>class</replacea
     <optional> allow-query { <replaceable>address_match_list</replaceable> }; </optional>
     <optional> server-addresses { <optional> <replaceable>ip_addr</replaceable> ; ... </optional> }; </optional>
     <optional> server-names { <optional> <replaceable>namelist</replaceable> </optional> }; </optional>
-    <optional> zone-statistics <replaceable>yes_or_no</replaceable> ; </optional>
+    <optional> zone-statistics <replaceable>full</replaceable> | <replaceable>terse</replaceable> | <replaceable>none</replaceable>; </optional>
 };
 
 zone <replaceable>zone_name</replaceable> <optional><replaceable>class</replaceable></optional> {
@@ -12635,11 +12635,9 @@ zone <replaceable>zone_name</replaceable> <optional><replaceable>class</replacea
 		<term><command>zone-statistics</command></term>
 		<listitem>
 		  <para>
-		    If <userinput>yes</userinput>, the server will keep
-		    statistical
-		    information for this zone, which can be dumped to the
-		    <command>statistics-file</command> defined in
-		    the server options.
+		    See the description of
+		    <command>zone-statistics</command> in
+		    <xref linkend="options"/>.
 		  </para>
 		</listitem>
 	      </varlistentry>
@@ -15620,12 +15618,17 @@ HOST-127.EXAMPLE. MX 0 .
 	  A subset of Name Server Statistics is collected and shown
 	  per zone for which the server has the authority when
 	  <command>zone-statistics</command> is set to
-	  <userinput>yes</userinput>.
-	  These statistics counters are shown with their zone and view
-	  names.
-	  In some cases the view names are omitted for the default view.
+	  <userinput>full</userinput> (or <userinput>yes</userinput>
+	  for backward compatibility. See the description of
+	  <command>zone-statistics</command> in <xref linkend="options"/>
+	  for further details.
 	</para>
 
+	<para>
+	  These statistics counters are shown with their zone and
+	  view names. The view name is omitted when the server is
+	  not configured with explicit views.</para>
+
 	<para>
 	  There are currently two user interfaces to get access to the
 	  statistics.