From: Thomas Markwalder <tmark@isc.org>
Date: Thu, 12 Nov 2015 16:05:10 +0000 (-0500)
Subject: [4117] Fixed ncr-protocol/ncr-format doc in admin guide
X-Git-Tag: trac4203_base~1^2
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=645a757e70466ad028569ad7884d76524b1ac06e;p=thirdparty%2Fkea.git

[4117] Fixed ncr-protocol/ncr-format doc in admin guide

Descriptions of the two parameters, ncr-protocol and ncr-format
were swapped in three places (but hey, we were consistent!):

    doc/guide/ddns.xml
    doc/guide/dhcp4-srv.xml
    doc/guide/dhcp6-srv.xml
---

diff --git a/doc/guide/ddns.xml b/doc/guide/ddns.xml
index 95d1582026..2867dc9647 100644
--- a/doc/guide/ddns.xml
+++ b/doc/guide/ddns.xml
@@ -152,7 +152,7 @@ strings <userinput>path</userinput>/kea-dhcp-ddns | sed -n 's/;;;; //p'
         If the file already exists and contains the PID of a live process,
         the server will issue a DHCP_DDNS_ALREADY_RUNNING log message and exit. It
         is possible, though unlikely, that the file is a remnant of a system crash
-        and the process to which the PID belongs is unrelated to Kea.  In such a 
+        and the process to which the PID belongs is unrelated to Kea.  In such a
         case it would be necessary to manually delete the PID file.
       </para>
 
@@ -233,15 +233,15 @@ strings <userinput>path</userinput>/kea-dhcp-ddns | sed -n 's/;;;; //p'
       </simpara></listitem>
 
       <listitem><simpara>
-      <command>ncr_protocol</command> - Packet format to use when sending requests to D2.
-      Currently only JSON format is supported.  Other formats may be available
-      in future releases.
+      <command>ncr_protocol</command> - Socket protocol to use when sending requests to D2.
+      Currently only UDP is supported.  TCP may be available in an upcoming
+      release.
       </simpara></listitem>
 
       <listitem><simpara>
-      <command>ncr_format</command> - Socket protocol to use when sending requests to D2.
-      Currently only UDP is supported.  TCP may be available in an upcoming
-      release.
+      <command>ncr_format</command> - Packet format to use when sending requests to D2.
+      Currently only JSON format is supported.  Other formats may be available
+      in future releases.
       </simpara></listitem>
 
       </itemizedlist>
diff --git a/doc/guide/dhcp4-srv.xml b/doc/guide/dhcp4-srv.xml
index 0f6cdd4560..8d6d4a7ed5 100644
--- a/doc/guide/dhcp4-srv.xml
+++ b/doc/guide/dhcp4-srv.xml
@@ -1769,18 +1769,15 @@ It is merely echoed by the server
       continue lease operations without running the risk that its memory usage
       grows without limit.  The default value is 1024.
       </simpara></listitem>
-
       <listitem><simpara>
-      <command>ncr-format</command> - socket protocol use when sending requests to D2.  Currently
+      <command>ncr-protocol</command> - socket protocol use when sending requests to D2.  Currently
       only UDP is supported.  TCP may be available in an upcoming release.
       </simpara></listitem>
-
       <listitem><simpara>
-      <command>ncr-protocol</command> - packet format to use when sending requests to D2.
+      <command>ncr-format</command> - packet format to use when sending requests to D2.
       Currently only JSON format is supported.  Other formats may be available
       in future releases.
       </simpara></listitem>
-
       </itemizedlist>
       By default, kea-dhcp-ddns is assumed to be running on the same machine as kea-dhcp4, and
       all of the default values mentioned above should be sufficient.
diff --git a/doc/guide/dhcp6-srv.xml b/doc/guide/dhcp6-srv.xml
index 11002006b0..088428e328 100644
--- a/doc/guide/dhcp6-srv.xml
+++ b/doc/guide/dhcp6-srv.xml
@@ -1751,11 +1751,11 @@ should include options from the isc option space:
       continue lease operations.  The default value is 1024.
       </simpara></listitem>
       <listitem><simpara>
-      <command>ncr-format</command> - Socket protocol use when sending requests to D2.  Currently
+      <command>ncr-protocol</command> - Socket protocol use when sending requests to D2.  Currently
       only UDP is supported.  TCP may be available in an upcoming release.
       </simpara></listitem>
       <listitem><simpara>
-      <command>ncr-protocol</command> - Packet format to use when sending requests to D2.
+      <command>ncr-format</command> - Packet format to use when sending requests to D2.
       Currently only JSON format is supported.  Other formats may be available
       in future releases.
       </simpara></listitem>