From: Tomek Mrugalski <tomasz@isc.org>
Date: Thu, 8 Jun 2017 11:15:15 +0000 (+0200)
Subject: [5189] Couple minor comment improvements.
X-Git-Tag: trac5243_base~4^2~2
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=2d704442c5717ef188be1ebd635bb0949a992ce6;p=thirdparty%2Fkea.git

[5189] Couple minor comment improvements.
---

diff --git a/src/lib/asiolink/tests/unix_domain_socket_unittest.cc b/src/lib/asiolink/tests/unix_domain_socket_unittest.cc
index a781b71a97..c08b4b0d24 100644
--- a/src/lib/asiolink/tests/unix_domain_socket_unittest.cc
+++ b/src/lib/asiolink/tests/unix_domain_socket_unittest.cc
@@ -170,7 +170,8 @@ TEST_F(UnixDomainSocketTest, asyncSendReceive) {
     // some data have been sent.
     ASSERT_GT(sent_size, 0);
 
-    // Receive response from the socket.
+    // Receive response from the socket. Very small receive buffer ensures that
+    // we will read the response in chunks.
     std::array<char, 2> read_buf;
     size_t bytes_read = 0;
     std::string response;
diff --git a/src/lib/asiolink/testutils/test_server_unix_socket.h b/src/lib/asiolink/testutils/test_server_unix_socket.h
index bbc0325ecc..3f21b9c021 100644
--- a/src/lib/asiolink/testutils/test_server_unix_socket.h
+++ b/src/lib/asiolink/testutils/test_server_unix_socket.h
@@ -72,6 +72,8 @@ public:
 
     /// @brief Generates response of a given length.
     ///
+    /// Note: The response may be a few bytes larger than requested.
+    ///
     /// @param response_size Desired response size.
     void generateCustomResponse(const uint64_t response_size);
 
diff --git a/src/lib/asiolink/unix_domain_socket.cc b/src/lib/asiolink/unix_domain_socket.cc
index 04f51c0d10..7a04a9c76c 100644
--- a/src/lib/asiolink/unix_domain_socket.cc
+++ b/src/lib/asiolink/unix_domain_socket.cc
@@ -50,7 +50,7 @@ public:
     /// necessarily indicate a problem and the subsequent attempts to read
     /// and write to the socket will succeed. Therefore, the handler simply
     /// overrides this error code with success status. The user supplied
-    /// handler don't need to deal with the EINPROGRESS error codes.
+    /// handler doesn't need to deal with the EINPROGRESS error codes.
     ///
     /// @param remote_handler User supplied callback.
     /// @param ec Error code returned as a result of connection.