From: Thomas Markwalder <tmark@isc.org>
Date: Wed, 15 Sep 2021 16:02:32 +0000 (-0400)
Subject: [#1307] Addressed review comments
X-Git-Tag: Kea-2.0.0~112
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=d1b581903e10d380f15e305606873ca26532dca5;p=thirdparty%2Fkea.git

[#1307] Addressed review comments

Minor clean ups in:

ChangeLog
doc/examples/kea4/all-keys.json
doc/examples/kea6/all-keys.json
doc/sphinx/arm/hooks-ha.rst
src/bin/dhcp4/tests/config_parser_unittest.cc
---

diff --git a/doc/examples/kea4/all-keys.json b/doc/examples/kea4/all-keys.json
index 1ad524ce39..4863f0e718 100644
--- a/doc/examples/kea4/all-keys.json
+++ b/doc/examples/kea4/all-keys.json
@@ -505,12 +505,11 @@
         // DHCPREQUESTs) that may be parked while waiting for hook library
         // work to complete, prior to a response (e.g. DHCPACK) being sent
         // back to the client.  A typical example is when kea-dhcp4 parks a
-        // DHCPREQUEST while it sends the requisite lease update(s) to its
-        // HA peer(s). The packet is unparked once the update(s) have been
-        // acknowledged.  This value limits the number of packets that can
-        // be held pending the updates. In times of heavy client traffic,
-        // this value can keep kea-dhcp4 from building an insurmountable
-        // backlog of updates.
+        // DHCPREQUEST while it sends the lease update(s) to its HA peer(s).
+        // The packet is unparked once the update(s) have been acknowledged.
+        // This value limits the number of packets that can be held pending
+        // the updates. In times of heavy client traffic, this value can keep
+        // kea-dhcp4 from building an insurmountable backlog of updates.
         "parked-packet-limit": 128,
 
         // List of global DHCP options that Kea DHCPv4 server assigns to the
diff --git a/doc/examples/kea6/all-keys.json b/doc/examples/kea6/all-keys.json
index 3eb2486280..9d2d028dd1 100644
--- a/doc/examples/kea6/all-keys.json
+++ b/doc/examples/kea6/all-keys.json
@@ -507,7 +507,7 @@
         // REQUESTs,RENEWs...) that may be parked while waiting for
         // hook library work to complete, prior to a response (e.g. REPLY)
         // being sent back to the client.  A typical example is when kea-dhcp6
-        // parks a REQUEST while it sends the requisite lease update(s) to its
+        // parks a REQUEST while it sends the lease update(s) to its
         // HA peer(s). The packet is unparked once the update(s) have been
         // acknowledged.  This value limits the number of packets that can
         // be held pending the updates. In times of heavy client traffic,
diff --git a/doc/sphinx/arm/hooks-ha.rst b/doc/sphinx/arm/hooks-ha.rst
index 337adc3e6e..6544d04a6f 100644
--- a/doc/sphinx/arm/hooks-ha.rst
+++ b/doc/sphinx/arm/hooks-ha.rst
@@ -1602,10 +1602,10 @@ Parked Packet Limit
 ~~~~~~~~~~~~~~~~~~~
 
 Kea servers contain a mechanism by which the response to a client packet may
-be held, pending completion of Hook library work.  We refer to this as "parking"
+be held, pending completion of hook library work.  We refer to this as "parking"
 the packet.  The HA hook library makes use of this mechanism. When an HA server
 needs to send a lease update to its peer(s) to notify it of the change to the
-lease, it will "park" the client response until the peer acknowleges the lease
+lease, it will "park" the client response until the peer acknowledges the lease
 update.  At that point, the server will "unpark" the response and send it to the
 client.  This applies to client queries which cause lease changes such as
 DHCPREQUEST for DHCPv4 and REQUEST, RENEW, REBIND for DHCPv6. It does not apply
@@ -1619,8 +1619,8 @@ the limit is reached, the server will emit a log and drop any further responses
 until the parking spaces are available.
 
 In general, smaller values for the parking lot limit are likely to cause more
-drops but with response times. Larger values are likely to result in fewer drops
-but with longer response times.  Currently, the default value for
+drops but with shorter response times. Larger values are likely to result in
+fewer drops but with longer response times.  Currently, the default value for
 parked-packet-limit is 256.
 
 ::
diff --git a/src/bin/dhcp4/tests/config_parser_unittest.cc b/src/bin/dhcp4/tests/config_parser_unittest.cc
index b87f48a584..65b96676aa 100644
--- a/src/bin/dhcp4/tests/config_parser_unittest.cc
+++ b/src/bin/dhcp4/tests/config_parser_unittest.cc
@@ -7528,7 +7528,8 @@ TEST_F(Dhcp4ParserTest, multiThreadingSettings) {
                 << "  actual: " << *(cfg) << std::endl;
 }
 
-// Check whether it is possible to parked-packet-limit
+// Verify that parsing for the global parameter, parked-packet-limit,
+// is correct.
 TEST_F(Dhcp4ParserTest, parkedPacketLimit) {
     // Config without parked-packet-limit
     string config_no_limit = "{ " + genIfaceConfig() + "," +