[#1087] Addressed editorial errors

Addressed all editorial errors in the docs and commentary as a result of
the review.

diff --git a/doc/sphinx/arm/hooks-ha.rst b/doc/sphinx/arm/hooks-ha.rst
index 4c335f27ff4cd7c52720419e6f16a0d96ee6991c..b7e506779cbccd8a3a721163ba0825c9ca92d307 100644 (file)
--- a/doc/sphinx/arm/hooks-ha.rst
+++ b/doc/sphinx/arm/hooks-ha.rst
@@ -1635,7 +1635,7 @@ information).
 The ``communication-interrupted`` boolean value indicates if the server
 receiving the ``status-get`` command (local server) has been unable to
 communicate with the partner longer than the duration specified as
-``max-response-delay``. In such situation we say that active servers are
+``max-response-delay``. In such a situation we say that active servers are
 in the communication interrupted state or that the communication between
 them is interrupted. At this point, the local server may start monitoring
 the DHCP traffic directed to the partner to see if the partner is

diff --git a/src/hooks/dhcp/high_availability/communication_state.cc b/src/hooks/dhcp/high_availability/communication_state.cc
index 10c5bc9dac81656f84174e31df3ac182aca3034b..67658b36a1f77b39d5eb266b01aa469ea80995cd 100644 (file)
--- a/src/hooks/dhcp/high_availability/communication_state.cc
+++ b/src/hooks/dhcp/high_availability/communication_state.cc
@@ -382,6 +382,7 @@ CommunicationState4::analyzeMessage(const boost::shared_ptr<dhcp::Pkt>& message)
         }
     }
 
+    // Only log the first time we detect a client is unacked.
     if (log_unacked) {
         unsigned unacked_left = 0;
         if (config_->getMaxUnackedClients() > getUnackedClientsCount()) {
@@ -475,6 +476,7 @@ CommunicationState6::analyzeMessage(const boost::shared_ptr<dhcp::Pkt>& message)
         }
     }
 
+    // Only log the first time we detect a client is unacked.
     if (log_unacked) {
         unsigned unacked_left = 0;
         if (config_->getMaxUnackedClients() > getUnackedClientsCount()) {

diff --git a/src/hooks/dhcp/high_availability/communication_state.h b/src/hooks/dhcp/high_availability/communication_state.h
index 0356f0d44057492c0da406b2579924cdac7d6408..0350fbca94a5ab3d2a6b3f9f42262cc08b15c226 100644 (file)
--- a/src/hooks/dhcp/high_availability/communication_state.h
+++ b/src/hooks/dhcp/high_availability/communication_state.h
@@ -228,7 +228,7 @@ public:
     virtual bool failureDetected() const = 0;
 
     /// @brief Returns the current number of clients which attempted
-    /// to get the lease from the partner server.
+    /// to get a lease from the partner server.
     ///
     /// The returned number is reset to 0 when the server successfully
     /// establishes communication with the partner. The number is
@@ -432,7 +432,7 @@ public:
     virtual bool failureDetected() const;
 
     /// @brief Returns the current number of clients which attempted
-    /// to get the lease from the partner server.
+    /// to get a lease from the partner server.
     ///
     /// The returned number is reset to 0 when the server successfully
     /// establishes communication with the partner. The number is
@@ -441,8 +441,8 @@ public:
     /// @return The number of clients including unacked clients.
     virtual size_t getConnectingClientsCount() const;
 
-    /// @brief Returns the current number of clients which haven't got
-    /// the lease from the partner server.
+    /// @brief Returns the current number of clients which haven't gotten
+    /// a lease from the partner server.
     ///
     /// The returned number is reset to 0 when the server successfully
     /// establishes communication with the partner. The number is
@@ -534,7 +534,7 @@ public:
     virtual bool failureDetected() const;
 
     /// @brief Returns the current number of clients which attempted
-    /// to get the lease from the partner server.
+    /// to get a lease from the partner server.
     ///
     /// The returned number is reset to 0 when the server successfully
     /// establishes communication with the partner. The number is
@@ -543,8 +543,8 @@ public:
     /// @return The number of clients including unacked clients.
     virtual size_t getConnectingClientsCount() const;
 
-    /// @brief Returns the current number of clients which haven't got
-    /// the lease from the partner server.
+    /// @brief Returns the current number of clients which haven't gotten
+    /// a lease from the partner server.
     ///
     /// The returned number is reset to 0 when the server successfully
     /// establishes communication with the partner. The number is
@@ -562,8 +562,8 @@ protected:
     /// See @c CommunicationState::analyzeMessage for details.
     virtual void clearConnectingClients();
 
-    /// @brief Structure holding information about the client which has
-    /// send the packet being analyzed.
+    /// @brief Structure holding information about a client which
+    /// sent a packet being analyzed.
     struct ConnectingClient6 {
         std::vector<uint8_t> duid_;
         bool unacked_;

diff --git a/src/hooks/dhcp/high_availability/ha_messages.mes b/src/hooks/dhcp/high_availability/ha_messages.mes
index a8b16a226a31f4eaece73875e261048744fdfcdb..c94f483ec7ea99c2f15dae13ff6730d335662b5e 100644 (file)
--- a/src/hooks/dhcp/high_availability/ha_messages.mes
+++ b/src/hooks/dhcp/high_availability/ha_messages.mes
@@ -71,7 +71,7 @@ the partner-down state.
 % HA_COMMUNICATION_INTERRUPTED_CLIENT4 %1: new client attempting to get a lease from the partner
 This informational message is issued when the surviving server observes
 a DHCP packet sent to the partner with which the commuication is interrupted.
-The client which packet is observed is not yet considered "unacked" because
+The client whose packet is observed is not yet considered "unacked" because
 the secs field value does not exceed the configured threshold specified
 with max-ack-delay.
 
@@ -82,14 +82,14 @@ is considered to not be served by the partner. The surviving server counts
 such clients and if the number of such clients exceeds the max-unacked-clients
 threshold, the server will transition to the partner-down state. The first
 argument contains client identification information. The second argument
-specifies the number of clients which the server failed to respond to. The
-third argument specifies the number of additional clients which, if not
+specifies the number of clients to which the server has failed to respond.
+The third argument specifies the number of additional clients which, if not
 provisioned, will cause the server to transition to the partner-down state.
 
 % HA_COMMUNICATION_INTERRUPTED_CLIENT6 %1: new client attempting to get a lease from the partner
 This informational message is issued when the surviving server observes
 a DHCP packet sent to the partner with which the commuication is interrupted.
-The client which packet is observed is not yet considered "unacked" because
+The client whose packet is observed is not yet considered "unacked" because
 the elapsed time option value does not exceed the configured threshold
 specified with max-ack-delay. The sole argument specifies client
 identification information.
@@ -101,8 +101,8 @@ is considered to not be served by the partner. The surviving server counts
 such clients and if the number of such clients exceeds the max-unacked-clients
 threshold, the server will transition to the partner-down state. The first
 argument contains client identification information. The second argument
-specifies the number of clients which the server failed to respond to. The
-third argument specifies the number of additional clients which, if not
+specifies the number of clients to which the server has failed to respond.
+The third argument specifies the number of additional clients which, if not
 provisioned, will cause the server to transition to the partner-down state.
 
 % HA_CONFIGURATION_FAILED failed to configure High Availability hooks library: %1